Java Doc for NamingEnumeration.java in  » 6.0-JDK-Core » naming » javax » naming » Java Source Code / Java DocumentationJava Source Code and Java Documentation

When a method such as list(), listBindings(), or search() returns a NamingEnumeration, any exceptions encountered are reserved until all results have been returned. At the end of the enumeration, the exception is thrown (by hasMore());

For example, if the list() is returning only a partial answer, the corresponding exception would be PartialResultException. list() would first return a NamingEnumeration. When the last of the results has been returned by the NamingEnumeration's next(), invoking hasMore() would result in PartialResultException being thrown.

In another example, if a search() method was invoked with a specified size limit of 'n'. If the answer consists of more than 'n' results, search() would first return a NamingEnumeration. When the n'th result has been returned by invoking next() on the NamingEnumeration, a SizeLimitExceedException would then thrown when hasMore() is invoked.

Note that if the program uses hasMoreElements() and nextElement() instead to iterate through the NamingEnumeration, because these methods cannot throw exceptions, no exception will be thrown. Instead, in the previous example, after the n'th result has been returned by nextElement(), invoking hasMoreElements() would return false.

Note also that NoSuchElementException is thrown if the program invokes next() or nextElement() when there are no elements left in the enumeration. The program can always avoid this exception by using hasMore() and hasMoreElements() to check whether the end of the enumeration has been reached.

If an exception is thrown during an enumeration, the enumeration becomes invalid. Subsequent invocation of any method on that enumeration will yield undefined results.
author:
   Rosanna Lee
author:
   Scott Seligman
version:
   1.15 07/05/05
See Also:   Context.list
See Also:   Context.listBindings
See Also:   javax.naming.directory.DirContext.search
See Also:   javax.naming.directory.Attributes.getAll
See Also:   javax.naming.directory.Attributes.getIDs
See Also:   javax.naming.directory.Attribute.getAll
since:
   1.3

This method indicates to the service provider that it is free to release resources associated with the enumeration, and can notify servers to cancel any outstanding requests.

This method indicates to the service provider that it is free to release resources associated with the enumeration, and can notify servers to cancel any outstanding requests. The close() method is a hint to implementations for managing their resources. Implementations are encouraged to use appropriate algorithms to manage their resources when client omits the close() calls.
exception:
  NamingException - If a naming exception is encounteredwhile closing the enumeration.
since:
   1.3

Note that next() can also throw the runtime exception NoSuchElementException to indicate that the caller is attempting to enumerate beyond the end of the enumeration. This is different from a NamingException, which indicates that there was a problem in obtaining the next element, for example, due to a referral or server unavailability, etc. The possibly null element in the enumeration.null is only valid for enumerations that can returnnull (e.g. Attribute.getAll() returns an enumeration ofattribute values, and an attribute value can be null).
exception:
  NamingException - If a naming exception is encountered while attemptingto retrieve the next element. See NamingExceptionand its subclasses for the possible naming exceptions.
exception:
  java.util.NoSuchElementException - If attempting to get the next element when none is available.
See Also:   java.util.Enumeration.nextElement