org.protempa.proposition.value

Class ValueList<V extends Value>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<V>

org.protempa.proposition.value.ValueList<V>

All Implemented Interfaces:

Serializable, Cloneable, Iterable<V>, Collection<V>, List<V>, RandomAccess, Value, ValueVisitable

public class ValueList<V extends Value>
extends ArrayList<V>
implements Value

Represents lists of values.

Author:

Andrew Post

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ValueList() Creates an empty list of values.
ValueList(int initialCapacity)
ValueList(List<V> values) Creates a list of values from the provided List of values.

Method Summary

Modifier and Type	Method and Description
void	accept(ValueVisitor valueVisitor) Performs some processing on a value.
ValueBuilder	asBuilder()
ValueComparator	compare(Value val) Compares a value list for membership in another value list.
String	format(Format format) Returns a string representing this value, formatted by the provided Format.
String	getFormatted() Returns a string representing this value for display purposes.
static <V extends Value> ValueList<V>	getInstance(V... value) Creates a list of the provided elements in the same order.
ValueType	getType() Returns this object's type, guaranteed not null.
ValueList<V>	replace() Returns a value from a cache that is equal to this one, if such a value exists.
String	toString()

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

ValueList

public ValueList(int initialCapacity)

ValueList

public ValueList()

Creates an empty list of values.

ValueList

public ValueList(List<V> values)

Creates a list of values from the provided List of values.

Parameters:

values - a List of values.

Method Detail

getInstance

public static <V extends Value> ValueList<V> getInstance(V... value)

Creates a list of the provided elements in the same order.

Parameters:

value - zero or more values.

Returns:

a list of the provided values.

replace

public ValueList<V> replace()

Description copied from interface: Value

Returns a value from a cache that is equal to this one, if such a value exists. Otherwise, it returns itself.

Specified by:

replace in interface Value

Returns:

a Value for which #equals(Value) is true.

compare

public ValueComparator compare(Value val)

Compares a value list for membership in another value list. This method does NOT compare two lists for equality. To do this, use AbstractList.equals(java.lang.Object).

Specified by:

compare in interface Value

Parameters:

o - a Value.

Returns:

if the provided value is a value list, returns ValueComparator.IN if the list is in the provided value list, or ValueComparator.NOT_IN if not. If the provided value is not a list, returns .

getFormatted

public String getFormatted()

Description copied from interface: Value

Returns a string representing this value for display purposes.

Specified by:

getFormatted in interface Value

Returns:

a String. Guaranteed not null.

format

public String format(Format format)

Description copied from interface: Value

Returns a string representing this value, formatted by the provided Format.

Specified by:

format in interface Value

Parameters:

format - a Format. Passing in a null will result in the same behavior as Value.getFormatted().

Returns:

a String.

toString

public String toString()

Overrides:

toString in class AbstractCollection<V extends Value>

getType

public ValueType getType()

Description copied from interface: Value

Returns this object's type, guaranteed not null.

Specified by:

getType in interface Value

Returns:

a ValueType.

accept

public void accept(ValueVisitor valueVisitor)

Description copied from interface: ValueVisitable

Performs some processing on a value.

Specified by:

accept in interface ValueVisitable

asBuilder

public ValueBuilder asBuilder()

Specified by:

asBuilder in interface Value