Interface BranchList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface BranchList
extends OsidList

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

while (bl.hasNext()) {
     Branch branch = bl.getNextBranch();
}            
  

or

while (rl.hasNext()) {
     Branch[] branches = bl.getNextBranches(bl.available());
}            
  

Method Summary

Modifier and Type	Method	Description
Branch	getNextBranch()	Gets the next Branch in this list.
Branch[]	getNextBranches(long n)	Gets the next set of Branches 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

getNextBranch

Branch getNextBranch()
              throws OperationFailedException

Gets the next Branch in this list.

Returns:

the next Branch in this list. The hasNext() method should be used to test that a next Branch 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.

getNextBranches

Branch[] getNextBranches(long n)
                  throws OperationFailedException

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

Parameters:

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

Returns:

an array of Branch 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.