OpenJDK 27 · com.sun.jndi.toolkit.dir.ContextEnumerator

Field Summary

Modifier and Type	Field and Description
private NamingEnumeration<Binding>	children
private String	contextName
private Binding	currentChild
private ContextEnumerator	currentChildEnum
private boolean	currentChildExpanded
private boolean	currentReturned
private static boolean	debug
private Context	root
private boolean	rootProcessed
private int	scope

Constructor Summary

Access	Constructor and Description
public	ContextEnumerator(Context context)
public	ContextEnumerator(Context context, int scope)
protected	ContextEnumerator(Context context, int scope, String contextName, boolean returnSelf)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements javax.naming.NamingEnumeration.close. Closes this enumeration.
protected NamingEnumeration<Binding>	getImmediateChildren(Context ctx)
private Binding	getNextChild()
private Binding	getNextDescendant()
public boolean	hasMore() Implements javax.naming.NamingEnumeration.hasMore. Determines whether there are any more elements in the enumeration.
private boolean	hasMoreChildren()
private boolean	hasMoreDescendants()
public boolean	hasMoreElements() Implements java.util.Enumeration.hasMoreElements. Tests if this enumeration contains more elements.
protected ContextEnumerator	newEnumerator(Context ctx, int scope, String contextName, boolean returnSelf)
public Binding	next() Implements javax.naming.NamingEnumeration.next. Retrieves the next element in the enumeration.
public Binding	nextElement() Implements java.util.Enumeration.nextElement. Returns the next element of this enumeration if this enumeration object has at least one more element to provide.
private void	prepNextChild()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

children	back to summary
private NamingEnumeration<Binding> children

contextName	back to summary
private String contextName

currentChild	back to summary
private Binding currentChild

currentChildEnum	back to summary
private ContextEnumerator currentChildEnum

currentChildExpanded	back to summary
private boolean currentChildExpanded

currentReturned	back to summary
private boolean currentReturned

debug	back to summary
private static boolean debug

root	back to summary
private Context root

rootProcessed	back to summary
private boolean rootProcessed

scope	back to summary
private int scope

Constructor Detail

ContextEnumerator	back to summary
public ContextEnumerator(Context context) throws NamingException

ContextEnumerator	back to summary
public ContextEnumerator(Context context, int scope) throws NamingException

ContextEnumerator	back to summary
protected ContextEnumerator(Context context, int scope, String contextName, boolean returnSelf) throws NamingException

Method Detail

close back to summary

close	back to summary
public void close() throws NamingException Implements javax.naming.NamingEnumeration.close. Doc from javax.naming.NamingEnumeration.close. Closes this enumeration. After this method has been invoked on this enumeration, the enumeration becomes invalid and subsequent invocation of any of its methods will yield undefined results. This method is intended for aborting an enumeration to free up resources. If an enumeration proceeds to the end--that is, until `hasMoreElements()` or `hasMore()` returns `false`-- resources will be freed up automatically and there is no need to explicitly call `close()`. 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. Exceptions NamingException: If a naming exception is encountered while closing the enumeration.

public void close() throws NamingException

Implements javax.naming.NamingEnumeration.close.

Doc from javax.naming.NamingEnumeration.close.

Closes this enumeration. After this method has been invoked on this enumeration, the enumeration becomes invalid and subsequent invocation of any of its methods will yield undefined results. This method is intended for aborting an enumeration to free up resources. If an enumeration proceeds to the end--that is, until hasMoreElements() or hasMore() returns false-- resources will be freed up automatically and there is no need to explicitly call close().

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.

Exceptions

NamingException:: If a naming exception is encountered while closing the enumeration.

getImmediateChildren	back to summary
protected NamingEnumeration<Binding> getImmediateChildren(Context ctx) throws NamingException

getNextChild	back to summary
private Binding getNextChild() throws NamingException

getNextDescendant	back to summary
private Binding getNextDescendant() throws NamingException

hasMore	back to summary
public boolean hasMore() throws NamingException Implements javax.naming.NamingEnumeration.hasMore. Doc from javax.naming.NamingEnumeration.hasMore. Determines whether there are any more elements in the enumeration. This method allows naming exceptions encountered while determining whether there are more elements to be caught and handled by the application. Exceptions NamingException: If a naming exception is encountered while attempting to determine whether there is another element in the enumeration. See NamingException and its subclasses for the possible naming exceptions.

hasMore

back to summary

public boolean hasMore() throws NamingException

Implements javax.naming.NamingEnumeration.hasMore.

Doc from javax.naming.NamingEnumeration.hasMore.

Determines whether there are any more elements in the enumeration. This method allows naming exceptions encountered while determining whether there are more elements to be caught and handled by the application.

Exceptions

NamingException:: If a naming exception is encountered while attempting to determine whether there is another element in the enumeration. See NamingException and its subclasses for the possible naming exceptions.

hasMoreChildren	back to summary
private boolean hasMoreChildren() throws NamingException

hasMoreDescendants	back to summary
private boolean hasMoreDescendants() throws NamingException

hasMoreElements	back to summary
public boolean hasMoreElements() Implements java.util.Enumeration.hasMoreElements. Doc from java.util.Enumeration.hasMoreElements. Tests if this enumeration contains more elements.

hasMoreElements

back to summary

public boolean hasMoreElements()

Implements java.util.Enumeration.hasMoreElements.

Doc from java.util.Enumeration.hasMoreElements.

Tests if this enumeration contains more elements.

newEnumerator	back to summary
protected ContextEnumerator newEnumerator(Context ctx, int scope, String contextName, boolean returnSelf) throws NamingException

next back to summary

next	back to summary
public Binding next() throws NamingException Implements javax.naming.NamingEnumeration.next. Doc from javax.naming.NamingEnumeration.next. Retrieves the next element in the enumeration. This method allows naming exceptions encountered while retrieving the next element to be caught and handled by the application. 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. Exceptions NamingException: If a naming exception is encountered while attempting to retrieve the next element. See NamingException and its subclasses for the possible naming exceptions.

public Binding next() throws NamingException

Implements javax.naming.NamingEnumeration.next.

Doc from javax.naming.NamingEnumeration.next.

Retrieves the next element in the enumeration. This method allows naming exceptions encountered while retrieving the next element to be caught and handled by the application.

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.

Exceptions

NamingException:: If a naming exception is encountered while attempting to retrieve the next element. See NamingException and its subclasses for the possible naming exceptions.

nextElement	back to summary
public Binding nextElement() Implements java.util.Enumeration.nextElement. Doc from java.util.Enumeration.nextElement. Returns the next element of this enumeration if this enumeration object has at least one more element to provide.

nextElement

back to summary

public Binding nextElement()

Implements java.util.Enumeration.nextElement.

Doc from java.util.Enumeration.nextElement.

Returns the next element of this enumeration if this enumeration object has at least one more element to provide.

prepNextChild	back to summary
private void prepNextChild() throws NamingException

public Class ContextEnumerator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail