org.genantics.list

Class Nil<V>

java.lang.Object

org.genantics.list.Nil<V>

All Implemented Interfaces:

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

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

Author:

Bob Foster

Field Summary

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.
boolean	isEmpty() Test if empty.
Iterator<V>	iterator() Iterate through the elements in the list.
CList<V>	removeFirst()
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() Get the number of elements in the collection.
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 class java.lang.Object

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

Method Detail

cons

public CList<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()

removeFirst

public CList<V> removeFirst()

contains

public boolean contains(V element)

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

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

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

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

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

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>

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()

Description copied from interface: Access

Get the number of elements in the collection. Depending on the collection, size() may have cost O(1), O(log(n) up to O(n).

Specified by:

size in interface Access<V>

Returns:

number of elements