org.genantics.list

Class ConsList<V>

java.lang.Object

org.genantics.list.ConsList<V>

Type Parameters:

V - list element type

All Implemented Interfaces:

Iterable<V>, Access<V>, CList<V>

public class ConsList<V>
extends Object
implements CList<V>

Classical immutable list. Use null for nil.

Author:

bobfoster

Field Summary

Fields inherited from interface org.genantics.list.CList

NIL

Fields inherited from interface org.genantics.access.Access

JAVA_8

Constructor Summary

Constructors

Constructor and Description
ConsList(V element, ConsList<V> next)

Method Summary

Methods

Modifier and Type	Method and Description
ConsList<V>	cons(V element) Add an element to the head of the list.
boolean	contains(V value) Test for element.
V	head() Get the head of the list.
boolean	isEmpty() Test if empty.
Iterator<V>	iterator() Iterate through the elements in the list.
Iterator<V>	reverseIterator() Get the elements in reverse order.
boolean	reverseVisit(ConditionalVisitor<V> visitor) Visit all elements in reverse order until visitor.visit() returns true;
void	reverseVisit(Visitor<V> visitor) Visit all elements in reverse order.
int	size() Return the number of elements in the list.
CList<V>	tail() Get the rest of the list after the head.
void	toCollection(Collection<V> collection) Copy elements in list to collection in order.
String	toString()
boolean	visit(ConditionalVisitor<V> visitor) Visit each element in order until visit returns false.
void	visit(Visitor<V> visitor) Visit each element in order.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConsList

public ConsList(V element,
        ConsList<V> next)

Method Detail

cons

public ConsList<V> cons(V element)

Description copied from interface: CList

Add an element to the head of the list.

Specified by:

cons in interface CList<V>

Returns:

new list

head

public V head()

Description copied from interface: CList

Get the head of the list.

Specified by:

head in interface CList<V>

Returns:

element

tail

public CList<V> tail()

Description copied from interface: CList

Get the rest of the list after the head. Note that getFirst/getRest are not the most efficient way to traverse the list elements.

Specified by:

tail in interface CList<V>

Returns:

list

See Also:

CList.iterator()

contains

public boolean contains(V value)

Description copied from interface: CList

Test for element.

Specified by:

contains in interface Access<V>

Specified by:

contains in interface CList<V>

Returns:

true if list contains element; otherwise, false

toString

public String toString()

Overrides:

toString in class Object

toCollection

public void toCollection(Collection<V> collection)

Description copied from interface: CList

Copy elements in list to collection in order.

Specified by:

toCollection in interface CList<V>

visit

public void visit(Visitor<V> visitor)

Description copied from interface: CList

Visit each element in order.

Specified by:

visit in interface Access<V>

Specified by:

visit in interface CList<V>

visit

public boolean visit(ConditionalVisitor<V> visitor)

Description copied from interface: CList

Visit each element in order until visit returns false.

If the list is empty, returns true.

Specified by:

visit in interface Access<V>

Specified by:

visit in interface CList<V>

Returns:

false if any call to visit returned false; otherwise true

isEmpty

public boolean isEmpty()

Description copied from interface: Access

Test if empty. isEmpty() is guaranteed to be an O(1) operation; it should always be used in preference to size() == 0, as the latter may have cost up to O(n);

Specified by:

isEmpty in interface Access<V>

Returns:

true if the collection contains no elements; otherwise false

size

public int size()

Return the number of elements in the list. Note this is an O(n) operation. If possible, use isEmpty() instead.

Specified by:

size in interface Access<V>

Returns:

list size

reverseIterator

public Iterator<V> reverseIterator()

Description copied from interface: Access

Get the elements in reverse order.

Specified by:

reverseIterator in interface Access<V>

Returns:

element iterator

reverseVisit

public void reverseVisit(Visitor<V> visitor)

Description copied from interface: Access

Visit all elements in reverse order.

Specified by:

reverseVisit in interface Access<V>

reverseVisit

public boolean reverseVisit(ConditionalVisitor<V> visitor)

Description copied from interface: Access

Visit all elements in reverse order until visitor.visit() returns true;

Specified by:

reverseVisit in interface Access<V>

Returns:

true if any call to visitor.visit() returned true; otherwise false

iterator

public Iterator<V> iterator()

Description copied from interface: CList

Iterate through the elements in the list. This is the most efficient way to traverse the list elements.

Specified by:

iterator in interface Iterable<V>

Specified by:

iterator in interface Access<V>

Specified by:

iterator in interface CList<V>

Returns:

element iterator