org.genantics.access

Interface Access<V>

All Known Subinterfaces:

CList<V>, IndexedAccess<V>

All Known Implementing Classes:

Array, Array.Empty, Array.References, Array.Values, CodedList, ConsList, Nil

public interface Access<V>

Element access and data common to all immutable collections.

Author:

Bob Foster

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	JAVA_8

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(V value) Test if collection contains value.
boolean	isEmpty() Test if empty.
Iterator<V>	iterator() Get the elements in order.
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.
boolean	visit(ConditionalVisitor<V> visitor) Visit all elements in order until visitor.visit() returns true;
void	visit(Visitor<V> visitor) Visit all elements in order.

Field Detail

JAVA_8

static final boolean JAVA_8

Method Detail

isEmpty

boolean isEmpty()

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

Returns:

true if the collection contains no elements; otherwise false

size

int size()

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

Returns:

number of elements

contains

boolean contains(V value)

Test if collection contains value.

Parameters:

value -

Returns:

true if equals comparison of value is true for at least one element in the collection; otherwise false

iterator

Iterator<V> iterator()

Get the elements in order.

Returns:

element iterator

reverseIterator

Iterator<V> reverseIterator()

Get the elements in reverse order.

Returns:

element iterator

visit

void visit(Visitor<V> visitor)

Visit all elements in order.

Parameters:

visitor -

visit

boolean visit(ConditionalVisitor<V> visitor)

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

Parameters:

visitor -

Returns:

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

reverseVisit

void reverseVisit(Visitor<V> visitor)

Visit all elements in reverse order.

Parameters:

visitor -

reverseVisit

boolean reverseVisit(ConditionalVisitor<V> visitor)

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

Parameters:

visitor -

Returns:

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