Interface BinNodeList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface BinNodeList
extends OsidList

Like all OsidLists , BinNodeList provides a means for accessing BinNode elements sequentially either one at a time or many at a time. Examples:

while (bnl.hasNext()) {
     BinNode node = bnl.getNextBinNode();
}            
  

or

while (bnl.hasNext()) {
     BinNode[] nodes = bnl.getNextBinNodes(bnl.available());
}            
  

Method Summary

Modifier and Type	Method	Description
BinNode	getNextBinNode()	Gets the next BinNode in this list.
BinNode[]	getNextBinNodes(long n)	Gets the next set of BinNode elements in this list which must be less than or equal to the return from available() .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidList

close

Modifier and Type	Method	Description
void	close()	Close this list.

Methods inherited from interface OsidList

available, hasNext, skip

Modifier and Type	Method	Description
long	available()	Gets the number of elements available for retrieval.
boolean	hasNext()	Tests if there are more elements in this list.
void	skip(long n)	Skip the specified number of elements in the list.

Method Details

getNextBinNode

BinNode getNextBinNode()
                throws OperationFailedException

Gets the next BinNode in this list.

Returns:

the next BinNode in this list. The hasNext() method should be used to test that a next BinNode is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextBinNodes

BinNode[] getNextBinNodes(long n)
                   throws OperationFailedException

Gets the next set of BinNode elements in this list which must be less than or equal to the return from available() .

Parameters:

n - the number of BinNode elements requested which must be less than or equal to available()

Returns:

an array of BinNode elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.