org.osid.mapping.path

Interface SignalList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface SignalList
extends OsidList

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

       
       
       while (lsl.hasNext()) {
            Signal signal = sl.getNextSignal();
       }
       
                   
       
  

or

       
       
       while (sl.hasNext()) {
            Signal[] signals = sl.getNextSignals(sl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Signal	getNextSignal() Gets the next Signal in this list.
Signal[]	getNextSignals(long n) Gets the next set of Signal elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextSignal

Signal getNextSignal()
                     throws OperationFailedException

Gets the next Signal in this list.

Returns:

the next Signal in this list. The hasNext() method should be used to test that a next Signal 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.

getNextSignals

Signal[] getNextSignals(long n)
                        throws OperationFailedException

Gets the next set of Signal elements in this list. The specified amount must be less than or equal to the return from available().

Parameters:

n - the number of Signal elements requested which must be less than or equal to available()

Returns:

an array of Signal 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.