com.bayesserver

Class NetworkNodeCollection

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<Node>

com.bayesserver.NetworkNodeCollection

All Implemented Interfaces:

Iterable<Node>, Collection<Node>, List<Node>

public final class NetworkNodeCollection
extends AbstractList<Node>

Represents the collection of Network.getNodes() maintained by the Network class. Duplicates and null values are not allowed.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Method Summary

Modifier and Type	Method and Description
void	add(int index, Node item) Inserts an element into the collection at the specified index.
void	clear() Removes all elements from the collection.
boolean	contains(Object o) Determines whether a Node is in the collection.
Node	get(int index) Gets the Node object at the specified index.
Node	get(String name) Performs a case sensitive lookup.
Node	get(String name, boolean throwIfNotFound) Performs a case sensitive lookup.
Network	getNetwork() The Network the collection belongs to.
int	indexOf(Object o) Determines the index of a specific Node in the collection.
Node	remove(int index) Removes an element from the collection at the specified index, and any links that it has.
boolean	remove(Node item) Removes the Node from the collection.
Node	set(int index, Node value) Sets the Node object at the specified index.
int	size()

Methods inherited from class java.util.AbstractList

add, addAll, equals, hashCode, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

addAll, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

get

public Node get(int index)

Gets the Node object at the specified index.

Specified by:

get in interface List<Node>

Specified by:

get in class AbstractList<Node>

Parameters:

index - The zero-based index of the Node to find.

Returns:

A Node.

Throws:

NullPointerException - Raised when value being set is null.

IllegalStateException - Raised if the value being set already belongs to a network.

IllegalArgumentException - index is less than 0.-or-index is equal to or greater than the collection count.

set

public Node set(int index,
                Node value)

Sets the Node object at the specified index.

Specified by:

set in interface List<Node>

Overrides:

set in class AbstractList<Node>

Parameters:

index - The zero-based index of the Node to find.

Returns:

A Node.

Throws:

NullPointerException - Raised when value being set is null.

IllegalStateException - Raised if the value being set already belongs to a network.

IllegalArgumentException - index is less than 0.-or-index is equal to or greater than the collection count.

getNetwork

public Network getNetwork()

The Network the collection belongs to.

get

public Node get(String name)

Performs a case sensitive lookup.

Parameters:

name - The name of the Node to find.

Returns:

The Node with the specified name; otherwise null.

get

public Node get(String name,
                boolean throwIfNotFound)

Performs a case sensitive lookup.

Parameters:

name - The name of the Node to find.

throwIfNotFound - When true throws an exception if the name is not found.

Returns:

The Node with the specified name; otherwise null.

contains

public boolean contains(Object o)

Determines whether a Node is in the collection. The operation is O(1).

Specified by:

contains in interface Collection<Node>

Specified by:

contains in interface List<Node>

Overrides:

contains in class AbstractCollection<Node>

Parameters:

o - The Node to locate in the collection. The value can be null.

Returns:

true if [o] is found in the collection; otherwise, false.

clear

public void clear()

Removes all elements from the collection.

Specified by:

clear in interface Collection<Node>

Specified by:

clear in interface List<Node>

Overrides:

clear in class AbstractList<Node>

add

public void add(int index,
                Node item)

Inserts an element into the collection at the specified index.

Specified by:

add in interface List<Node>

Overrides:

add in class AbstractList<Node>

Parameters:

index - The zero based index at which to add the element.

item - The item to insert. Cannot be null.

Throws:

NullPointerException - Raised when [item] is null.

IllegalStateException - Raised if the node already belongs to a network.

IllegalArgumentException - index is less than 0.-or-index is equal to or greater than the collection count.

indexOf

public int indexOf(Object o)

Determines the index of a specific Node in the collection. This operation is O(1).

Specified by:

indexOf in interface List<Node>

Overrides:

indexOf in class AbstractList<Node>

Parameters:

o - The node. The value can be null.

Returns:

The index of the node or -1 if not found.

remove

public boolean remove(Node item)

Removes the Node from the collection.

Parameters:

item - The Node to be removed from the collection.

Returns:

true if item was successfully removed from the collection; otherwise, false. This method also returns false if item is not found in the collection.

Throws:

NullPointerException - Raised if [item] is null.

remove

public Node remove(int index)

Removes an element from the collection at the specified index, and any links that it has.

Specified by:

remove in interface List<Node>

Overrides:

remove in class AbstractList<Node>

Parameters:

index - The zero based index at which to remove the element.

Throws:

IllegalArgumentException - index is less than 0.-or-index is equal to or greater than the collection count.

size

public int size()

Specified by:

size in interface Collection<Node>

Specified by:

size in interface List<Node>

Specified by:

size in class AbstractCollection<Node>