org.genantics.list

Interface CList<V>

All Superinterfaces:

Access<V>, Iterable<V>

All Known Implementing Classes:

CodedList, ConsList, Nil

public interface CList<V>
extends Iterable<V>, Access<V>

Classical List interface.

Author:

bobfoster

Field Summary

Fields

Modifier and Type	Field and Description
static Nil	NIL

Fields inherited from interface org.genantics.access.Access

JAVA_8

Method Summary

Methods

Modifier and Type	Method and Description
CList<V>	cons(V element) Add an element to the head of the list.
boolean	contains(V element) Test for element.
V	head() Get the head of the list.
Iterator<V>	iterator() Iterate through the 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.
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 interface org.genantics.access.Access

isEmpty, reverseIterator, reverseVisit, reverseVisit, size

Field Detail

NIL

static final Nil NIL

Method Detail

cons

CList<V> cons(V element)

Add an element to the head of the list.

Parameters:

element -

Returns:

new list

contains

boolean contains(V element)

Test for element.

Specified by:

contains in interface Access<V>

Parameters:

element -

Returns:

true if list contains element; otherwise, false

head

V head()

Get the head of the list.

Returns:

element

tail

CList<V> tail()

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

Returns:

list

See Also:

iterator()

iterator

Iterator<V> iterator()

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

Specified by:

iterator in interface Access<V>

Specified by:

iterator in interface Iterable<V>

Returns:

visit

void visit(Visitor<V> visitor)

Visit each element in order.

Specified by:

visit in interface Access<V>

Parameters:

visitor -

visit

boolean visit(ConditionalVisitor<V> visitor)

Visit each element in order until visit returns false.

If the list is empty, returns true.

Specified by:

visit in interface Access<V>

Parameters:

visitor -

Returns:

false if any call to visit returned false; otherwise true

toCollection

void toCollection(Collection<V> collection)

Copy elements in list to collection in order.

Parameters:

collection -