Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface DKSequentialIterator

All Superinterfaces:
dkIterator
All Known Subinterfaces:
dkFederatedIterator
All Known Implementing Classes:
DKSegmentedPartsIterator

public interface DKSequentialIterator
extends dkIterator

A sequaential iterator is bi-directional; it can go forward and backward over members of a collection that supports it.


Method Summary
 java.lang.Object at()
          Gets the current element in the collection.
 java.lang.Object previous()
          Gets the current element in the collection and repositions the iterator to the previous element.
 boolean setToFirst()
          Sets to the first element in the collection.
 boolean setToLast()
          Sets to the last element in the collection.
 boolean setToNext()
          Sets to the next element in the collection.
 boolean setToPrevious()
          Sets to the previous element in the collection.
 
Methods inherited from interface com.ibm.mm.sdk.common.dkIterator
more, next, reset
 

Method Detail

previous

public java.lang.Object previous()
                          throws DKUsageError
Gets the current element in the collection and repositions the iterator to the previous element.
Returns:
current element.

setToFirst

public boolean setToFirst()
Sets to the first element in the collection.
Returns:
true if position is valid.

setToLast

public boolean setToLast()
Sets to the last element in the collection.
Returns:
true if position is valid.

setToNext

public boolean setToNext()
Sets to the next element in the collection.
Returns:
true if position is valid.

setToPrevious

public boolean setToPrevious()
Sets to the previous element in the collection.
Returns:
true if position is valid.

at

public java.lang.Object at()
                    throws DKUsageError
Gets the current element in the collection.
Returns:
current element.

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.