org.opends.server.backends.jeb
Class IDSetIterator

java.lang.Object
  org.opends.server.backends.jeb.IDSetIterator

All Implemented Interfaces:

java.util.Iterator<EntryID>

public class IDSetIterator
extends java.lang.Object
implements java.util.Iterator<EntryID>

Iterator for a set of Entry IDs. It must return values in order of ID.

Constructor Summary

IDSetIterator(long[] entryIDList)
Create a new iterator for a given array of entry IDs.

IDSetIterator(long[] entryIDList, EntryID begin)
Create a new iterator for a given array of entry IDs.

Method Summary

boolean	hasNext() Returns true if the iteration has more elements.
EntryID	next() Returns the next element in the iteration.
void	remove() Removes from the underlying collection the last element returned by the iterator (optional operation).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IDSetIterator

public IDSetIterator(long[] entryIDList)

Create a new iterator for a given array of entry IDs.

Parameters:

entryIDList - An array of IDs in order or ID.

IDSetIterator

public IDSetIterator(long[] entryIDList,
                     EntryID begin)

Create a new iterator for a given array of entry IDs.

Parameters:

entryIDList - An array of IDs in order or ID.

begin - The entry ID of the first entry that should be returned, or null if it should start at the beginning of the list.

Method Detail

hasNext

public boolean hasNext()

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Specified by:

hasNext in interface java.util.Iterator<EntryID>

Returns:

true if the iterator has more elements.

next

public EntryID next()
             throws java.util.NoSuchElementException

Returns the next element in the iteration. Calling this method repeatedly until the hasNext() method returns false will return each element in the underlying collection exactly once.

Specified by:

next in interface java.util.Iterator<EntryID>

Returns:

the next element in the iteration.

Throws:

java.util.NoSuchElementException - iteration has no more elements.

remove

public void remove()
            throws java.lang.UnsupportedOperationException

Removes from the underlying collection the last element returned by the iterator (optional operation). This method can be called only once per call to next. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method.

Specified by:

remove in interface java.util.Iterator<EntryID>

Throws:

java.lang.UnsupportedOperationException - if the remove operation is not supported by this Iterator.