Interface EdgeEnablerList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface EdgeEnablerList extends OsidList

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

while (eel.hasNext()) {
     EdgeEnabler enabler = eel.getNextEdgeEnabler();
}
or 
while (eel.hasNext()) {
     EdgeEnabler[] enablers = eel.getNextEdgeEnablers(eel.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    EdgeEnabler
    getNextEdgeEnabler()
    Gets the next EdgeEnabler in this list.
    EdgeEnabler[]
    getNextEdgeEnablers(long n)
    Gets the next set of EdgeEnabler elements in this list.

    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

    • getNextEdgeEnabler

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

    • getNextEdgeEnablers

      EdgeEnabler[] getNextEdgeEnablers(long n) throws OperationFailedException
      Gets the next set of EdgeEnabler elements in this list. The specified amount must be less than or equal to the return from available() .
      Parameters:
      n - the number of EdgeEnabler elements requested which must be less than or equal to available()
      Returns:
      an array of EdgeEnabler 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.