OSID Logo
OSID Specifications
topology package
Version 3.0.0
Interfaceosid.topology.EdgeList
Implementsosid.OsidList
Used Byosid.topology.EdgeGraphSession
osid.topology.EdgeLookupSession
osid.topology.EdgeQuerySession
osid.topology.EdgeSearchResults
osid.topology.TopologyRoutingSession
osid.topology.TopologyTraversalSession
osid.topology.path.Path
osid.topology.rules.EdgeEnablerRuleLookupSession
Description

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

while (el.hasNext()) {
     Edge edge = el.getNextEdge();
}            
                
or
while (el.hasNext()) {
     Edge[] edges = el.getNextEdges(el.available());
}            
                
MethodgetNextEdge
Description

Gets the next Edge in this list.

Returnosid.topology.Edgethe next Edge in this list. The hasNext() method should be used to test that a next Edge is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextEdges
Description

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

Parameterscardinalnthe number of Edge elements requested which must be less than or equal to available()
Returnosid.topology.Edge[]an array of Edge elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.