com.yworks.yfiles.algorithms

Class NodeList

java.lang.Object

com.yworks.yfiles.algorithms.YList

com.yworks.yfiles.algorithms.NodeList

All Implemented Interfaces:

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

public class NodeList
extends YList
implements ICollection<Object>

Specialized list implementation for instances of type Node.

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
NodeList() Creates an empty node list.
NodeList(INodeCursor c) Creates a list that is initialized with the nodes provided by the given NodeCursor object.
NodeList(INodeCursor nc, IDataProvider predicate) Creates a list that is initialized with those nodes from the given NodeCursor object for which the given data provider returns true upon calling its getBool method.
NodeList(Node v) Creates a list that is initialized with a single node provided.
NodeList(Node[] a) Creates a list that is initialized with the nodes provided by the given array of nodes.
NodeList(NodeList list) Creates a list that is initialized with the entries of the given list.

Method Summary

Modifier and Type	Method and Description
Node	firstNode() Returns the first node in this list, or null when the list is empty.
Node	lastNode() Returns the last node in this list, or null when the list is empty.
INodeCursor	nodes() Returns a node cursor for this node list.
Node	popNode() Removes the first node from this list and returns it.
Object[]	toArray(Object[] a) Returns an array containing all list elements in the correct order.
Node[]	toNodeArray() Returns a node 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, 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

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

NodeList

public NodeList()

Creates an empty node list.

NodeList

public NodeList(INodeCursor c)

Creates a list that is initialized with the nodes provided by the given NodeCursor object.

NodeList

public NodeList(INodeCursor nc,
                IDataProvider predicate)

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

Parameters:

nc - A node cursor providing nodes that should be added to this list.

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

NodeList

public NodeList(Node v)

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

NodeList

public NodeList(Node[] a)

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

NodeList

public NodeList(NodeList list)

Creates a list that is initialized with the entries of the given list.

Parameters:

list - the values are added to the new list

Method Detail

firstNode

public final Node firstNode()

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

Returns:

The first node in the list.

lastNode

public final Node lastNode()

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

Returns:

The last node in the list.

nodes

public final INodeCursor nodes()

Returns a node cursor for this node list.

Returns:

A node cursor granting access to the nodes within this list.

popNode

public final Node popNode()

Removes the first node from this list and returns it.

Returns:

The first node from the list.

toArray

public Object[] toArray(Object[] a)

Description copied from class: YList

Returns an array containing all list elements in the correct order.

The runtime type of the returned array is that of the given array.

If the list does not fit in the specified array, a new array is allocated with the runtime type of the specified array and the size of this list.

If the list fits in the specified array with room to spare (i.e., the array has more elements than the list), the element in the array immediately following the end of the collection is set to null. This is useful in determining the length of the list only if the caller knows that the list does not contain any null elements.

Specified by:

toArray in interface ICollection<Object>

Specified by:

toArray in interface Collection<Object>

Specified by:

toArray in interface List<Object>

Overrides:

toArray in class YList

Parameters:

a - The array into which the elements of the list are to be stored, if it is big enough. Otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:

toNodeArray

public final Node[] toNodeArray()

Returns a node array containing all elements of this list in the canonical order.