Interface EndpointList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
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());
}

  • Method Summary

    Modifier and Type
    Method
    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() .

    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

    • getNextEndpoint

      Endpoint getNextEndpoint() throws OperationFailedException
      Gets the next Endpoint in this list.
      Returns:
      the next Endpoint in this list. The hasNext() method should be used to test that a next Endpoint 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.

    • getNextEndpoints

      Endpoint[] getNextEndpoints(long n) throws OperationFailedException
      Gets the next set of Endpoint objects in this lis which must be less than or equal to whst is returned from available() .
      Parameters:
      n - the number of Endpoint elements requested which should be less than or equal to available()
      Returns:
      an array of Endpoint 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.