1 /* NamingEnumeration.java -- The JNDI enumeration 2 Copyright (C) 2000, 2006 Free Software Foundation, Inc. 3 4 This file is part of GNU Classpath. 5 6 GNU Classpath is free software; you can redistribute it and/or modify 7 it under the terms of the GNU General Public License as published by 8 the Free Software Foundation; either version 2, or (at your option) 9 any later version. 10 11 GNU Classpath is distributed in the hope that it will be useful, but 12 WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 General Public License for more details. 15 16 You should have received a copy of the GNU General Public License 17 along with GNU Classpath; see the file COPYING. If not, write to the 18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19 02110-1301 USA. 20 21 Linking this library statically or dynamically with other modules is 22 making a combined work based on this library. Thus, the terms and 23 conditions of the GNU General Public License cover the whole 24 combination. 25 26 As a special exception, the copyright holders of this library give you 27 permission to link this library with independent modules to produce an 28 executable, regardless of the license terms of these independent 29 modules, and to copy and distribute the resulting executable under 30 terms of your choice, provided that you also meet, for each linked 31 independent module, the terms and conditions of the license of that 32 module. An independent module is a module which is not derived from 33 or based on this library. If you modify this library, you may extend 34 this exception to your version of the library, but you are not 35 obligated to do so. If you do not wish to do so, delete this 36 exception statement from your version. */ 37 38 39 package javax.naming; 40 41 import java.util.Enumeration; 42 43 /** 44 * <p>The specific type of enumeration that supports throwing various exceptions by 45 * the hasMore method. The exceptions are only thrown if the enumeration is 46 * scanned using {@link #next()} and {@link #hasMore()}. If the inherited 47 * {@link java.util.Enumeration#nextElement()} and 48 * {@link Enumeration#hasMoreElements()} are used instead, the exceptions are 49 * not throwed, and the enumeration is just iterated over available elements. 50 * </p> 51 * <p>This enumeration becomes invalid after throwing the exception. If the 52 * exception has been thrown, not other method should be called of that 53 * enumeration.</p> 54 */ 55 public interface NamingEnumeration<T> extends Enumeration<T> 56 { 57 /** 58 * Returns the next element in this enumeration. The naming - specific 59 * exceptions are only throws after returning all still available elements of 60 * the enumeration. 61 * 62 * @return the next element of this enumeration 63 * @throws NamingException 64 */ next()65 T next() throws NamingException; 66 67 /** 68 * Checks if there are more unvisited elements in the enumeration, throwing 69 * exceptions if there are some unvisited, but not available elements. 70 * 71 * @return true if there are some unvisited elements, false otherwise. 72 * @throws PartialResultException if the enumeration, returned by the 73 * {@link Context#list(Name)} or other similar method contains only 74 * partial answer. 75 * @throws SizeLimitExceededException if remaining elements are not available 76 * because of the previously specified size limit. 77 * @throws NamingException 78 */ hasMore()79 boolean hasMore() throws NamingException; 80 81 /** 82 * Immediately frees all resources, owned by this enumeration. If invoked, it 83 * must be the last method called for that enumeration. 84 * 85 * @throws NamingException 86 */ close()87 void close() throws NamingException; 88 89 } 90