Package one.microstream.collections

Class ConstLinearEnum<E>

java.lang.Object

one.microstream.collections.AbstractExtendedCollection<E>

one.microstream.collections.AbstractArrayCollection<E>

one.microstream.collections.AbstractSectionedArrayCollection<E>

one.microstream.collections.AbstractSimpleArrayCollection<E>

one.microstream.collections.ConstLinearEnum<E>

All Implemented Interfaces:

Iterable<E>, CapacityCarrying, ExtendedCollection<E>, ExtendedSequence<E>, Sized, XGettingCollection<E>, XGettingEnum<E>, XGettingSequence<E>, XGettingSet<E>, XImmutableCollection<E>, XImmutableEnum<E>, XImmutableSequence<E>, XImmutableSet<E>, XIndexIterable<E>, XIterable<E>, XJoinable<E>, ThreadSafe, IdentityEqualityLogic, HashImmutable, Copyable, Immutable

public final class ConstLinearEnum<E>
extends AbstractSimpleArrayCollection<E>
implements XImmutableEnum<E>, IdentityEqualityLogic

Version:

0.91, 2011-02-28

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConstLinearEnum.OldConstEnum<E>

Nested classes/interfaces inherited from interface one.microstream.typing.Copyable

Copyable.Static

Nested classes/interfaces inherited from interface one.microstream.collections.interfaces.ExtendedCollection

ExtendedCollection.Creator<E,C extends ExtendedCollection<E>>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingCollection

XGettingCollection.Creator<E>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingEnum

XGettingEnum.Creator<E>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingSet

XGettingSet.Creator<E>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XImmutableEnum

XImmutableEnum.Factory<E>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XIterable

XIterable.Executor<E>

Constructor Summary

Constructors

Constructor	Description
ConstLinearEnum()
ConstLinearEnum(int initialCapacity)
ConstLinearEnum(E... elements)
ConstLinearEnum(E[] src, int srcStart, int srcLength)
ConstLinearEnum(ConstLinearEnum<? extends E> original)
ConstLinearEnum(XGettingCollection<? extends E> elements)

Method Summary

Modifier and Type	Method	Description
boolean	applies(Predicate<? super E> predicate)
E	at(long index)
boolean	contains(E element)
boolean	containsAll(XGettingCollection<? extends E> elements)
boolean	containsId(E element)	Special version of contains() that guarantees to use identity comparison (" == ") when searching for the given element regardless of the collection's internal logic. This method has the same behavior as XGettingCollection.containsSearched(Predicate) with a Predicate implementation that checks for object identity.
boolean	containsSearched(Predicate<? super E> predicate)
ConstLinearEnum<E>	copy()	Creates a true copy of this collection which references the same elements as this collection does at the time the method is called.
<C extends Consumer<? super E>> C	copySelection(C target, long... indices)
<C extends Consumer<? super E>> C	copyTo(C target)
long	count(E element)
long	countBy(Predicate<? super E> predicate)
<C extends Consumer<? super E>> C	distinct(C target)
<C extends Consumer<? super E>> C	distinct(C target, Equalator<? super E> equalator)
Equalator<? super E>	equality()
boolean	equals(Object o)	Deprecated.
boolean	equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)	Returns true if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator) yields true.
boolean	equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)	Returns true if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.
<C extends Consumer<? super E>> C	except(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)
<C extends Consumer<? super E>> C	filterTo(C target, Predicate<? super E> predicate)
E	first()
E	get()	Gets one element from the collection.
int	hashCode()	Deprecated.
boolean	hasVolatileElements()	Tells if this collection contains volatile elements. An element is volatile, if it can become no longer reachable by the collection without being removed from the collection.
ConstLinearEnum<E>	immure()	Always returns the already immutable collection instance itself
long	indexBy(Predicate<? super E> predicate)
long	indexOf(E element)
<C extends Consumer<? super E>> C	intersect(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)
boolean	isEmpty()
boolean	isFull()	Returns true if the current capacity cannot be increased any more.
boolean	isSorted(Comparator<? super E> comparator)
<P extends Consumer<? super E>> P	iterate(P procedure)
<P extends IndexedAcceptor<? super E>> P	iterateIndexed(P procedure)
Iterator<E>	iterator()
<A> A	join(BiConsumer<? super E,? super A> joiner, A aggregate)
E	last()
long	lastIndexBy(Predicate<? super E> predicate)
long	lastIndexOf(E element)
E	max(Comparator<? super E> comparator)
long	maximumCapacity()	Returns the maximum amount of elements this carrier instance can contain. The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g.
long	maxIndex(Comparator<? super E> comparator)
E	min(Comparator<? super E> comparator)
long	minIndex(Comparator<? super E> comparator)
boolean	nullAllowed()
boolean	nullContained()
ConstLinearEnum.OldConstEnum<E>	old()
E	peek()
E	poll()
ConstLinearEnum<E>	range(long fromIndex, long toIndex)
long	remainingCapacity()	Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.
<T> T[]	rngCopyTo(int startIndex, int length, T[] target, int offset)
long	scan(Predicate<? super E> predicate)	Iterates through the collection and returns the index of the last element that the passed Predicateapplied to ("scanning").
E	search(Predicate<? super E> predicate)
E	seek(E sample)	Returns the first contained element matching the passed sample as defined by the collection's equality logic or null, if no fitting element is contained.
long	size()
Object[]	toArray()
E[]	toArray(Class<E> type)
ConstLinearEnum<E>	toReversed()
String	toString()
<C extends Consumer<? super E>> C	union(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)
ConstLinearEnum<E>	view()
ConstLinearEnum<E>	view(long lowIndex, long highIndex)

Methods inherited from class one.microstream.collections.AbstractArrayCollection

pow2BoundMaxed

Methods inherited from class one.microstream.collections.AbstractExtendedCollection

ensureFreeArrayCapacity, validateIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface one.microstream.collections.types.XGettingCollection

intSize

Methods inherited from interface one.microstream.collections.types.XGettingSequence

hasIndex

Constructor Details

ConstLinearEnum

public ConstLinearEnum()

ConstLinearEnum

public ConstLinearEnum(int initialCapacity)

ConstLinearEnum

public ConstLinearEnum(ConstLinearEnum<? extends E> original) throws NullPointerException

Throws:

NullPointerException

ConstLinearEnum

public ConstLinearEnum(XGettingCollection<? extends E> elements) throws NullPointerException

Throws:

NullPointerException

ConstLinearEnum

@SafeVarargs public ConstLinearEnum(E... elements) throws NullPointerException

Throws:

NullPointerException

ConstLinearEnum

public ConstLinearEnum(E[] src, int srcStart, int srcLength)

Method Details

equality

public Equalator<? super E> equality()

Specified by:

equality in interface XGettingCollection<E>

copy

public ConstLinearEnum<E> copy()

Description copied from interface: XGettingCollection

Creates a true copy of this collection which references the same elements as this collection does at the time the method is called. The elements themselves are NOT copied (no deep copying).
The type of the returned set is the same as of this list if possible.

Specified by:

copy in interface Copyable

Specified by:

copy in interface XGettingCollection<E>

Specified by:

copy in interface XGettingEnum<E>

Specified by:

copy in interface XGettingSequence<E>

Specified by:

copy in interface XGettingSet<E>

Specified by:

copy in interface XImmutableCollection<E>

Specified by:

copy in interface XImmutableEnum<E>

Specified by:

copy in interface XImmutableSequence<E>

Specified by:

copy in interface XImmutableSet<E>

Returns:

a copy of this list

immure

public ConstLinearEnum<E> immure()

Description copied from interface: XImmutableEnum

Always returns the already immutable collection instance itself

For spawning a copy of the collection instance, see XImmutableCollection.copy()

Specified by:

immure in interface XGettingCollection<E>

Specified by:

immure in interface XGettingEnum<E>

Specified by:

immure in interface XGettingSequence<E>

Specified by:

immure in interface XGettingSet<E>

Specified by:

immure in interface XImmutableCollection<E>

Specified by:

immure in interface XImmutableEnum<E>

Specified by:

immure in interface XImmutableSequence<E>

Specified by:

immure in interface XImmutableSet<E>

Returns:

a reference to the instance itself.

See Also:

XImmutableCollection.copy()

toReversed

public ConstLinearEnum<E> toReversed()

Specified by:

toReversed in interface XGettingEnum<E>

Specified by:

toReversed in interface XGettingSequence<E>

Specified by:

toReversed in interface XImmutableEnum<E>

Specified by:

toReversed in interface XImmutableSequence<E>

toArray

public E[] toArray(Class<E> type)

Specified by:

toArray in interface XGettingCollection<E>

iterate

public final <P extends Consumer<? super E>> P iterate(P procedure)

Specified by:

iterate in interface XGettingEnum<E>

Specified by:

iterate in interface XGettingSet<E>

Specified by:

iterate in interface XIterable<E>

iterateIndexed

public final <P extends IndexedAcceptor<? super E>> P iterateIndexed(P procedure)

Specified by:

iterateIndexed in interface XIndexIterable<E>

join

public final <A> A join(BiConsumer<? super E,? super A> joiner, A aggregate)

Specified by:

join in interface XGettingCollection<E>

Specified by:

join in interface XJoinable<E>

count

public long count(E element)

Specified by:

count in interface XGettingCollection<E>

countBy

public long countBy(Predicate<? super E> predicate)

Specified by:

countBy in interface XGettingCollection<E>

indexOf

public long indexOf(E element)

Specified by:

indexOf in interface XGettingSequence<E>

indexBy

public long indexBy(Predicate<? super E> predicate)

Specified by:

indexBy in interface XGettingSequence<E>

lastIndexOf

public long lastIndexOf(E element)

Specified by:

lastIndexOf in interface XGettingSequence<E>

lastIndexBy

public long lastIndexBy(Predicate<? super E> predicate)

Specified by:

lastIndexBy in interface XGettingSequence<E>

maxIndex

public long maxIndex(Comparator<? super E> comparator)

Specified by:

maxIndex in interface XGettingSequence<E>

minIndex

public long minIndex(Comparator<? super E> comparator)

Specified by:

minIndex in interface XGettingSequence<E>

scan

public long scan(Predicate<? super E> predicate)

Description copied from interface: XGettingSequence

Iterates through the collection and returns the index of the last element that the passed Predicateapplied to ("scanning").

Specified by:

scan in interface XGettingSequence<E>

Returns:

the index of the last positively tested element.

get

public E get()

Description copied from interface: XGettingCollection

Gets one element from the collection. If the collection is not ordered XGettingSequence, then it is undefined which element is returned. If the collection is ordered, the element at index 0 is returned.

Specified by:

get in interface XGettingCollection<E>

Specified by:

get in interface XGettingSequence<E>

Returns:

the first / any element.

See Also:

XGettingSequence.at(long), XGettingSequence.first(), XGettingSequence.last()

first

public E first()

Specified by:

first in interface XGettingSequence<E>

last

public E last()

Specified by:

last in interface XGettingSequence<E>

poll

public E poll()

Specified by:

poll in interface XGettingSequence<E>

peek

public E peek()

Specified by:

peek in interface XGettingSequence<E>

seek

public E seek(E sample)

Description copied from interface: XGettingCollection

Returns the first contained element matching the passed sample as defined by the collection's equality logic or null, if no fitting element is contained. (For collections using referential equality, this method is basically just a variation of XGettingCollection.contains(Object) with a different return type. For collections with data-dependant equality, the returned element might be the same as the passed one or a data-wise equal one, depending on the content of the collection)

Specified by:

seek in interface XGettingCollection<E>

search

public E search(Predicate<? super E> predicate)

Specified by:

search in interface XGettingCollection<E>

max

public E max(Comparator<? super E> comparator)

Specified by:

max in interface XGettingCollection<E>

min

public E min(Comparator<? super E> comparator)

Specified by:

min in interface XGettingCollection<E>

hasVolatileElements

public boolean hasVolatileElements()

Description copied from interface: XGettingCollection

Tells if this collection contains volatile elements.
An element is volatile, if it can become no longer reachable by the collection without being removed from the collection. Examples are WeakReference of SoftReference or implementations of collection entries that remove the element contained in an entry by some means outside the collection.
Note that WeakReference instances that are added to a a simple (non-volatile) implementation of a collection do NOT make the collection volatile, as the elements themselves (the reference instances) are still strongly referenced.

Specified by:

hasVolatileElements in interface ExtendedCollection<E>

Specified by:

hasVolatileElements in interface XGettingCollection<E>

Returns:

true if the collection contains volatile elements.

nullAllowed

public boolean nullAllowed()

Specified by:

nullAllowed in interface ExtendedCollection<E>

isSorted

public boolean isSorted(Comparator<? super E> comparator)

Specified by:

isSorted in interface XGettingSequence<E>

containsSearched

public boolean containsSearched(Predicate<? super E> predicate)

Specified by:

containsSearched in interface XGettingCollection<E>

applies

public boolean applies(Predicate<? super E> predicate)

Specified by:

applies in interface XGettingCollection<E>

nullContained

public boolean nullContained()

Specified by:

nullContained in interface XGettingCollection<E>

containsId

public boolean containsId(E element)

Description copied from interface: XGettingCollection

Special version of contains() that guarantees to use identity comparison (" == ") when searching for the given element regardless of the collection's internal logic.
This method has the same behavior as XGettingCollection.containsSearched(Predicate) with a Predicate implementation that checks for object identity. The only difference is a performance and usability advantage

Specified by:

containsId in interface XGettingCollection<E>

Parameters:

element - the element to be searched in the collection by identity.

Returns:

whether this collection contains exactely the given element.

contains

public boolean contains(E element)

Specified by:

contains in interface XGettingCollection<E>

containsAll

public boolean containsAll(XGettingCollection<? extends E> elements)

Specified by:

containsAll in interface XGettingCollection<E>

equals

public boolean equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)

Description copied from interface: XGettingCollection

Returns true if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator) yields true.

Specified by:

equals in interface XGettingCollection<E>

equalsContent

public boolean equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)

Description copied from interface: XGettingCollection

Returns true if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.

Note that for colletion types that don't have a defined order of elements, this method is hardly usable (as is XGettingCollection.equals(Object) for them as defined in Collection). The core problem of comparing collections that have no defined order is that they aren't really reliably comparable to any other collection.

Specified by:

equalsContent in interface XGettingCollection<E>

equalator - the equalator to use to determine the equality of each element

Returns:

true if this list is equal to the passed list, false otherwise

intersect

public <C extends Consumer<? super E>> C intersect(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)

Specified by:

intersect in interface XGettingCollection<E>

except

public <C extends Consumer<? super E>> C except(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)

Specified by:

except in interface XGettingCollection<E>

union

public <C extends Consumer<? super E>> C union(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)

Specified by:

union in interface XGettingCollection<E>

copyTo

public <C extends Consumer<? super E>> C copyTo(C target)

Specified by:

copyTo in interface XGettingCollection<E>

filterTo

public <C extends Consumer<? super E>> C filterTo(C target, Predicate<? super E> predicate)

Specified by:

filterTo in interface XGettingCollection<E>

rngCopyTo

public <T> T[] rngCopyTo(int startIndex, int length, T[] target, int offset)

distinct

public <C extends Consumer<? super E>> C distinct(C target)

Specified by:

distinct in interface XGettingCollection<E>

distinct

public <C extends Consumer<? super E>> C distinct(C target, Equalator<? super E> equalator)

Specified by:

distinct in interface XGettingCollection<E>

copySelection

public <C extends Consumer<? super E>> C copySelection(C target, long... indices)

Specified by:

copySelection in interface XGettingSequence<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Sized

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface XGettingCollection<E>

size

public long size()

Specified by:

size in interface Sized

Specified by:

size in interface XGettingCollection<E>

maximumCapacity

public long maximumCapacity()

Description copied from interface: CapacityCarrying

Returns the maximum amount of elements this carrier instance can contain.
The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g. Integer.MAX_VALUE)

Specified by:

maximumCapacity in interface CapacityCarrying

Returns:

the maximum amount of elements this carrier instance can contain.

isFull

public boolean isFull()

Description copied from interface: CapacityCarrying

Returns true if the current capacity cannot be increased any more.

Specified by:

isFull in interface CapacityCarrying

remainingCapacity

public long remainingCapacity()

Description copied from interface: CapacityCarrying

Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.

Specified by:

remainingCapacity in interface CapacityCarrying

view

public ConstLinearEnum<E> view()

Specified by:

view in interface XGettingCollection<E>

Specified by:

view in interface XGettingEnum<E>

Specified by:

view in interface XGettingSequence<E>

view

public ConstLinearEnum<E> view(long lowIndex, long highIndex)

Specified by:

view in interface XGettingEnum<E>

Specified by:

view in interface XGettingSequence<E>

range

public ConstLinearEnum<E> range(long fromIndex, long toIndex)

Specified by:

range in interface XGettingEnum<E>

Specified by:

range in interface XGettingSequence<E>

toString

public String toString()

Overrides:

toString in class Object

toArray

public Object[] toArray()

Specified by:

toArray in interface XGettingCollection<E>

at

public E at(long index) throws ArrayIndexOutOfBoundsException

Specified by:

at in interface XGettingSequence<E>

Throws:

ArrayIndexOutOfBoundsException

equals

@Deprecated public boolean equals(Object o)

Deprecated.

Description copied from interface: XGettingCollection

Performs an equality comparison according to the specification in Collection.

Note that it is this interface's author opinion that the whole concept of equals() in standard Java, especially in the collection implementations, is flawed.
The reason is because all different kinds of comparison types that actually depend on the situation have to be mixed up in a harcoded fashion in one method, from identity comparison over data indentity comparison to content comparison.
In order to get the right behavior in every situation, one has to distinct between different types of equality

This means several things:
1.) You can't just say for example an ArrayList is the "same" as a LinkedList just because they contain the same content.
There are different implementations for a good reason, so you have to distinct them when comparing. There are simple code examples which create massive misbehavior that will catastrophically ruin the runtime behavior of a programm due to this error in Java / JDK / Sun / whatever.
2.) You can't always determine equality of two collections by determining equality of each element as Collection defines it.

As a conclusion: don't use this method!
Be clear what type of comparison you really need, then use one of the following methods and proper comparators:
XGettingCollection.equals(XGettingCollection,Equalator)
XGettingCollection.equalsContent(XGettingCollection,Equalator)

Specified by:

equals in interface HashImmutable

Specified by:

equals in interface XGettingCollection<E>

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object can be treated as the same as other,false otherwise.

See Also:

HashImmutable.hashCode()

hashCode

@Deprecated public int hashCode()

Deprecated.

Description copied from interface: HashImmutable

Marker declaration to indicate that for classes of this type, Object.hashCode() can be properly used.

Specified by:

hashCode in interface HashImmutable

Specified by:

hashCode in interface XGettingCollection<E>

Overrides:

hashCode in class Object

Returns:

a hash code value for this object corresponding to the implementation of HashImmutable.equals(Object)

See Also:

HashImmutable.equals(java.lang.Object)

old

public ConstLinearEnum.OldConstEnum<E> old()

Specified by:

old in interface XGettingCollection<E>