Package org.jgrapht.alg.shortestpath

Class AbstractPathElementList<V,E,T extends AbstractPathElement<V,E>>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

org.jgrapht.alg.shortestpath.AbstractPathElementList<V,E,T>

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>

Direct Known Subclasses:

RankingPathElementList

abstract class AbstractPathElementList<V,E,T extends AbstractPathElement<V,E>>
extends java.util.AbstractList<T>

List of paths AbstractPathElement with same target vertex.

Since:

July 5, 2007

Field Summary

Fields

Modifier and Type	Field	Description
protected Graph<V,E>	graph
protected int	maxSize	Max number of stored paths.
protected java.util.ArrayList<T>	pathElements	Stored paths, list of AbstractPathElement.
protected V	vertex	Target vertex of the paths.

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPathElementList(Graph<V,E> graph, int maxSize, AbstractPathElementList<V,E,T> elementList, E edge)	Creates paths obtained by concatenating the specified edge to the specified paths.
protected	AbstractPathElementList(Graph<V,E> graph, int maxSize, T pathElement)	Creates a list with an empty path.
protected	AbstractPathElementList(Graph<V,E> graph, int maxSize, V vertex)	Creates an empty list.

Method Summary

Modifier and Type	Method	Description
T	get(int index)	Returns path AbstractPathElement stored at the specified index.
V	getVertex()	Returns target vertex.
int	size()	Returns the number of paths stored in the list.

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, 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.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

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

Field Detail

graph

protected Graph<V,E> graph

maxSize

protected int maxSize

Max number of stored paths.

pathElements

protected java.util.ArrayList<T extends AbstractPathElement<V,E>> pathElements

Stored paths, list of AbstractPathElement.

vertex

protected V vertex

Target vertex of the paths.

Constructor Detail

AbstractPathElementList

protected AbstractPathElementList(Graph<V,E> graph,
                                  int maxSize,
                                  AbstractPathElementList<V,E,T> elementList,
                                  E edge)

Creates paths obtained by concatenating the specified edge to the specified paths.

Parameters:

maxSize - maximum number of paths the list is able to store.

elementList - paths, list of AbstractPathElement.

edge - edge reaching the end vertex of the created paths.

Throws:

java.lang.NullPointerException - if the specified prevPathElementList or edge is null.

java.lang.IllegalArgumentException - if maxSize is negative or 0.

AbstractPathElementList

protected AbstractPathElementList(Graph<V,E> graph,
                                  int maxSize,
                                  T pathElement)

Creates a list with an empty path. The list size is 1.

Parameters:

maxSize - maximum number of paths the list is able to store.

Throws:

java.lang.NullPointerException - if the specified path-element is null.

java.lang.IllegalArgumentException - if maxSize is negative or 0.

java.lang.IllegalArgumentException - if pathElement is not empty.

AbstractPathElementList

protected AbstractPathElementList(Graph<V,E> graph,
                                  int maxSize,
                                  V vertex)

Creates an empty list. The list size is 0.

Parameters:

maxSize - maximum number of paths the list is able to store.

Throws:

java.lang.IllegalArgumentException - if maxSize is negative or 0.

Method Detail

get

public T get(int index)

Returns path AbstractPathElement stored at the specified index.

Specified by:

get in interface java.util.List<V>

Specified by:

get in class java.util.AbstractList<T extends AbstractPathElement<V,E>>

getVertex

public V getVertex()

Returns target vertex.

size

public int size()

Returns the number of paths stored in the list.

Specified by:

size in interface java.util.Collection<V>

Specified by:

size in interface java.util.List<V>

Specified by:

size in class java.util.AbstractCollection<T extends AbstractPathElement<V,E>>