public interface FamilyList extends OsidList
Like all OsidLists,
FamilyList
provides a
means for accessing Family
elements sequentially either one
at a time or many at a time. Examples:
while (fl.hasNext()) { Family family = fl.getNextFamily(); }or
while (fl.hasNext()) { Family[] families = fl.getNextFamilies(fl.available()); }
Modifier and Type | Method and Description |
---|---|
Family[] |
getNextFamilies(long n)
Gets the next set of
Family elements in this list. |
Family |
getNextFamily()
Gets the next
Family in this list. |
Family getNextFamily() throws OperationFailedException
Family
in this list. Family
in this list. The
hasNext()
method should be used to test that a next
Family
is available before calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Family[] getNextFamilies(long n) throws OperationFailedException
Family elements
in this list. The
specified amount must be less than or equal to the return from
available().
n
- the number of Family
elements requested which
must be less than or equal to available()
Family
elements.
The
length of the array is less than or equal to the number
specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.