Interface PropertyList

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

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

while (pl.hasNext()) {
     Property property = pl.getNextProperty();
}
or 
while (pl.hasNext()) {
     Property[] properties = pl.getNextProperties(pl.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    Property[]
    getNextProperties(long n)
    Gets the next set of Property elements in this list which must be less than or equal to the number returned from available() .
    Property
    getNextProperty()
    Gets the next Property 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

    • getNextProperty

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

    • getNextProperties

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