com.yworks.yfiles.algorithms

Class EdgeList

java.lang.Object

com.yworks.yfiles.algorithms.YList

com.yworks.yfiles.algorithms.EdgeList

All Implemented Interfaces:

ICollection<Object>, IEnumerable<Object>, Iterable<Object>, Collection<Object>, List<Object>

public class EdgeList
extends YList
implements ICollection<Object>

Specialized list implementation for instances of type Edge.

Field Summary

Fields inherited from interface com.yworks.yfiles.utils.ICollection

EMPTY

Constructor Summary

Constructors

Constructor and Description
EdgeList() Creates an empty edge list.
EdgeList(Edge e) Creates a list that is initialized with a single edge provided.
EdgeList(Edge[] a) Creates a list that is initialized with the edges provided by the given array of edges.
EdgeList(EdgeList edgeList) Creates a list that is initialized with an EdgeList.
EdgeList(IEdgeCursor c) Creates a list that is initialized with the edges provided by the given EdgeCursor object.
EdgeList(IEdgeCursor ec, IDataProvider predicate) Creates a list that is initialized with those edges from the given EdgeCursor object for which the given data provider returns true upon calling its getBool method.

Method Summary

Modifier and Type	Method and Description
IEdgeCursor	edges() Returns an edge cursor for this edge list.
Edge	firstEdge() Returns the first edge in this list, or null when the list is empty.
Edge	lastEdge() Returns the last edge in this list, or null when the list is empty.
Edge	popEdge() Removes the first edge from this list and returns it.
Edge[]	toEdgeArray() Returns an edge array containing all elements of this list in the canonical order.

Methods inherited from class com.yworks.yfiles.algorithms.YList

add, add, addAll, addAll, addAll, addFirst, addFirstCell, addLast, addLastCell, clear, contains, containsAll, copyTo, copyTo, cursor, cyclicPred, cyclicSucc, elementAt, enumerator, equals, findCell, first, firstCell, get, getCell, getInfo, hashCode, indexOf, insertAfter, insertBefore, insertCellAfter, insertCellBefore, isEmpty, last, lastCell, lastIndexOf, listIterator, parallelStream, peek, pop, popLast, predCell, push, remove, removeAll, removeAt, removeCell, retainAll, reverse, set, setInfo, size, sort, sort, splice, stream, subList, succCell, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.yworks.yfiles.utils.ICollection

addAll, containsAll, isEmpty, iterator, parallelStream, remove, removeAll, retainAll, stream, toArray, toArray

Methods inherited from interface com.yworks.yfiles.utils.IEnumerable

concat, concat, create, create, enumerator

Methods inherited from interface java.util.Collection

add, clear, contains, equals, hashCode, removeIf, size, spliterator

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

iterator, listIterator, remove, replaceAll, spliterator

Constructor Detail

EdgeList

public EdgeList()

Creates an empty edge list.

EdgeList

public EdgeList(Edge e)

Creates a list that is initialized with a single edge provided.

EdgeList

public EdgeList(Edge[] a)

Creates a list that is initialized with the edges provided by the given array of edges.

EdgeList

public EdgeList(EdgeList edgeList)

Creates a list that is initialized with an EdgeList.

EdgeList

public EdgeList(IEdgeCursor c)

Creates a list that is initialized with the edges provided by the given EdgeCursor object.

EdgeList

public EdgeList(IEdgeCursor ec,
                IDataProvider predicate)

Creates a list that is initialized with those edges from the given EdgeCursor object for which the given data provider returns true upon calling its getBool method.

Parameters:

ec - An edge cursor providing edges that should be added to this list.

predicate - A data provider that acts as a inclusion predicate for each edge accessible by the given edge cursor.

Method Detail

edges

public final IEdgeCursor edges()

Returns an edge cursor for this edge list.

Returns:

An edge cursor granting access to the edges within this list.

firstEdge

public final Edge firstEdge()

Returns the first edge in this list, or null when the list is empty.

Returns:

The first edge in the list.

lastEdge

public final Edge lastEdge()

Returns the last edge in this list, or null when the list is empty.

Returns:

The last edge in the list.

popEdge

public final Edge popEdge()

Removes the first edge from this list and returns it.

Returns:

The first edge from the list.

toEdgeArray

public final Edge[] toEdgeArray()

Returns an edge array containing all elements of this list in the canonical order.