com.sun.ws.management.server
Interface EnumerationIterator

All Known Subinterfaces:

EnumerationPullIterator

All Known Implementing Classes:

EventingIterator

public interface EnumerationIterator

The inteface to be presented by a data source that would like to be enumerated by taking advantage of the functionality present in EnumerationSupport.

See Also:

EnumerationSupport

Method Summary

int	estimateTotalItems() Estimate the total number of elements available.
boolean	hasNext() Indicates if there are more elements remaining in the iteration.
boolean	isFiltered() Indicates if the iterator has already been filtered.
EnumerationItem	next() Supply the next element of the iteration.
void	release() Release any resources being used by the iterator.

Method Detail

estimateTotalItems

int estimateTotalItems()

Estimate the total number of elements available.

Returns:

an estimate of the total number of elements available in the enumeration. Return a negative number if an estimate is not available.

isFiltered

boolean isFiltered()

Indicates if the iterator has already been filtered. This indicates that further filtering is not required by the framwork.

Returns:

true if the iterator has already been filtered, false otherwise.

hasNext

boolean hasNext()

Indicates if there are more elements remaining in the iteration.

Returns:

true if there are more elements in the iteration, false otherwise.

next

EnumerationItem next()

Supply the next element of the iteration. This is invoked to satisfy a Pull request.

Returns:

an Element that is used to construct proper responses for a PullResponse.

release

void release()

Release any resources being used by the iterator. Calls to other methods of this iterator instance will exhibit undefined behaviour, after this method completes.