public interface EndpointList extends OsidList
Like all OsidLists,
EndpointList
provides
a means for accessing Endpoint
elements sequentially either
one at a time or many at a time. Examples:
while (el.hasNext()) { Endpoint endpoint = el.getNextEndpoint(); }or
while (el.hasNext()) { Endpoint[] endpoints = el.getNextEndpoints(el.available()); }
Modifier and Type | Method and Description |
---|---|
Endpoint |
getNextEndpoint()
Gets the next
Endpoint in this list. |
Endpoint[] |
getNextEndpoints(long n)
Gets the next set of
Endpoint objects in this lis which
must be less than or equal to whst is returned from
available(). |
Endpoint getNextEndpoint() throws OperationFailedException
Endpoint
in this list. Endpoint
in this list. The
hasNext()
method should be used to test that a next
Endpoint
is available before calling this
method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Endpoint[] getNextEndpoints(long n) throws OperationFailedException
Endpoint
objects in this lis which
must be less than or equal to whst is returned from
available().
n
- the number of Endpoint
elements requested
which should be less than or equal to available()
Endpoint
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.