Class ConstList<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.ConstList<E>
-
- All Implemented Interfaces:
Iterable<E>
,CapacityCarrying
,ExtendedBag<E>
,ExtendedCollection<E>
,ExtendedList<E>
,ExtendedSequence<E>
,Sized
,XGettingBag<E>
,XGettingCollection<E>
,XGettingList<E>
,XGettingSequence<E>
,XImmutableBag<E>
,XImmutableCollection<E>
,XImmutableList<E>
,XImmutableSequence<E>
,XIndexIterable<E>
,XIterable<E>
,XJoinable<E>
,ThreadSafe
,IdentityEqualityLogic
,HashImmutable
,Composition
,Copyable
,Immutable
public final class ConstList<E> extends AbstractSimpleArrayCollection<E> implements XImmutableList<E>, Composition, IdentityEqualityLogic
Immutable implementation of extended collection typeXGettingList
.For mutable extended lists (implementors of
XSettingList
,XList
), seeFixedList
,LimitList
,BulkList
.As instances of this class are completely immutable after creation, this list is automatically thread-safe.
Also note that by being an extended collection, this implementation offers various functional and batch procedures to maximize internal iteration potential, eliminating the need to use the ill-conceived external iteration
Iterator
paradigm.- Version:
- 0.91, 2011-02-28
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ConstList.OldConstList<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.XImmutableList
XImmutableList.Factory<E>
-
Nested classes/interfaces inherited from interface one.microstream.collections.types.XIterable
XIterable.Executor<E>
-
-
Constructor Summary
Constructors Constructor Description ConstList()
-
Method Summary
Modifier and Type Method Description boolean
applies(Predicate<? super E> predicate)
E
at(long index)
static <E> Aggregator<E,ConstList<E>>
Builder()
static <E> Aggregator<E,ConstList<E>>
Builder(int initialCapacity)
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 asXGettingCollection.containsSearched(Predicate)
with aPredicate
implementation that checks for object identity.boolean
containsSearched(Predicate<? super E> predicate)
ConstList<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>>
CcopySelection(C target, long... indices)
<C extends Consumer<? super E>>
CcopyTo(C target)
long
count(E element)
long
countBy(Predicate<? super E> predicate)
<C extends Consumer<? super E>>
Cdistinct(C target)
<C extends Consumer<? super E>>
Cdistinct(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)
Returnstrue
if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)
yieldstrue
.boolean
equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
Returnstrue
if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.<C extends Consumer<? super E>>
Cexcept(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)
<C extends Consumer<? super E>>
CfilterTo(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.ConstList<E>
immure()
Always returns the already immutable collection instance itselflong
indexBy(Predicate<? super E> predicate)
long
indexOf(E element)
<C extends Consumer<? super E>>
Cintersect(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>>
Piterate(P procedure)
<P extends IndexedAcceptor<? super E>>
PiterateIndexed(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)
ListIterator<E>
listIterator()
ListIterator<E>
listIterator(long index)
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)
static <T> ConstList<T>
New()
static <T> ConstList<T>
New(int initialCapacity)
static <T> ConstList<T>
New(ConstList<? extends T> original)
static <T> ConstList<T>
New(XGettingCollection<? extends T> elements)
static <T> ConstList<T>
New(T... elements)
static <T> ConstList<T>
New(T[] src, int srcStart, int srcLength)
boolean
nullAllowed()
boolean
nullContained()
ConstList.OldConstList<E>
old()
E
peek()
E
poll()
ConstList<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 passedPredicate
applied 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)
ConstList<E>
toReversed()
String
toString()
<C extends Consumer<? super E>>
Cunion(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)
ConstList<E>
view()
ConstList<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
-
-
-
-
Method Detail
-
Builder
public static <E> Aggregator<E,ConstList<E>> Builder()
-
Builder
public static <E> Aggregator<E,ConstList<E>> Builder(int initialCapacity)
-
New
public static <T> ConstList<T> New()
-
New
public static <T> ConstList<T> New(int initialCapacity)
-
New
public static <T> ConstList<T> New(ConstList<? extends T> original) throws NullPointerException
- Throws:
NullPointerException
-
New
public static <T> ConstList<T> New(XGettingCollection<? extends T> elements) throws NullPointerException
- Throws:
NullPointerException
-
New
@SafeVarargs public static <T> ConstList<T> New(T... elements) throws NullPointerException
- Throws:
NullPointerException
-
New
public static <T> ConstList<T> New(T[] src, int srcStart, int srcLength)
-
equality
public Equalator<? super E> equality()
- Specified by:
equality
in interfaceXGettingCollection<E>
-
copy
public ConstList<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 interfaceCopyable
- Specified by:
copy
in interfaceXGettingBag<E>
- Specified by:
copy
in interfaceXGettingCollection<E>
- Specified by:
copy
in interfaceXGettingList<E>
- Specified by:
copy
in interfaceXGettingSequence<E>
- Specified by:
copy
in interfaceXImmutableBag<E>
- Specified by:
copy
in interfaceXImmutableCollection<E>
- Specified by:
copy
in interfaceXImmutableList<E>
- Specified by:
copy
in interfaceXImmutableSequence<E>
- Returns:
- a copy of this list
-
immure
public ConstList<E> immure()
Description copied from interface:XImmutableList
Always returns the already immutable collection instance itselfFor spawning a copy of the collection instance, see
XImmutableCollection.copy()
- Specified by:
immure
in interfaceXGettingBag<E>
- Specified by:
immure
in interfaceXGettingCollection<E>
- Specified by:
immure
in interfaceXGettingList<E>
- Specified by:
immure
in interfaceXGettingSequence<E>
- Specified by:
immure
in interfaceXImmutableBag<E>
- Specified by:
immure
in interfaceXImmutableCollection<E>
- Specified by:
immure
in interfaceXImmutableList<E>
- Specified by:
immure
in interfaceXImmutableSequence<E>
- Returns:
- a reference to the instance itself.
- See Also:
XImmutableCollection.copy()
-
toReversed
public ConstList<E> toReversed()
- Specified by:
toReversed
in interfaceXGettingList<E>
- Specified by:
toReversed
in interfaceXGettingSequence<E>
- Specified by:
toReversed
in interfaceXImmutableList<E>
- Specified by:
toReversed
in interfaceXImmutableSequence<E>
-
join
public final <A> A join(BiConsumer<? super E,? super A> joiner, A aggregate)
-
iterateIndexed
public final <P extends IndexedAcceptor<? super E>> P iterateIndexed(P procedure)
- Specified by:
iterateIndexed
in interfaceXIndexIterable<E>
-
count
public long count(E element)
- Specified by:
count
in interfaceXGettingCollection<E>
-
countBy
public long countBy(Predicate<? super E> predicate)
- Specified by:
countBy
in interfaceXGettingCollection<E>
-
indexOf
public long indexOf(E element)
- Specified by:
indexOf
in interfaceXGettingSequence<E>
-
indexBy
public long indexBy(Predicate<? super E> predicate)
- Specified by:
indexBy
in interfaceXGettingSequence<E>
-
lastIndexOf
public long lastIndexOf(E element)
- Specified by:
lastIndexOf
in interfaceXGettingSequence<E>
-
lastIndexBy
public long lastIndexBy(Predicate<? super E> predicate)
- Specified by:
lastIndexBy
in interfaceXGettingSequence<E>
-
maxIndex
public long maxIndex(Comparator<? super E> comparator)
- Specified by:
maxIndex
in interfaceXGettingSequence<E>
-
minIndex
public long minIndex(Comparator<? super E> comparator)
- Specified by:
minIndex
in interfaceXGettingSequence<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 passedPredicate
applied to ("scanning").- Specified by:
scan
in interfaceXGettingSequence<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 orderedXGettingSequence
, then it is undefined which element is returned. If the collection is ordered, the element at index 0 is returned.- Specified by:
get
in interfaceXGettingCollection<E>
- Specified by:
get
in interfaceXGettingSequence<E>
- Returns:
- the first / any element.
- See Also:
XGettingSequence.at(long)
,XGettingSequence.first()
,XGettingSequence.last()
-
first
public E first()
- Specified by:
first
in interfaceXGettingSequence<E>
-
last
public E last()
- Specified by:
last
in interfaceXGettingSequence<E>
-
poll
public E poll()
- Specified by:
poll
in interfaceXGettingSequence<E>
-
peek
public E peek()
- Specified by:
peek
in interfaceXGettingSequence<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 ofXGettingCollection.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 interfaceXGettingCollection<E>
-
search
public E search(Predicate<? super E> predicate)
- Specified by:
search
in interfaceXGettingCollection<E>
-
max
public E max(Comparator<? super E> comparator)
- Specified by:
max
in interfaceXGettingCollection<E>
-
min
public E min(Comparator<? super E> comparator)
- Specified by:
min
in interfaceXGettingCollection<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 areWeakReference
ofSoftReference
or implementations of collection entries that remove the element contained in an entry by some means outside the collection.
Note thatWeakReference
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 interfaceExtendedCollection<E>
- Specified by:
hasVolatileElements
in interfaceXGettingCollection<E>
- Returns:
true
if the collection contains volatile elements.
-
nullAllowed
public boolean nullAllowed()
- Specified by:
nullAllowed
in interfaceExtendedCollection<E>
-
isSorted
public boolean isSorted(Comparator<? super E> comparator)
- Specified by:
isSorted
in interfaceXGettingSequence<E>
-
containsSearched
public boolean containsSearched(Predicate<? super E> predicate)
- Specified by:
containsSearched
in interfaceXGettingCollection<E>
-
applies
public boolean applies(Predicate<? super E> predicate)
- Specified by:
applies
in interfaceXGettingCollection<E>
-
nullContained
public boolean nullContained()
- Specified by:
nullContained
in interfaceXGettingCollection<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 asXGettingCollection.containsSearched(Predicate)
with aPredicate
implementation that checks for object identity. The only difference is a performance and usability advantage- Specified by:
containsId
in interfaceXGettingCollection<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 interfaceXGettingCollection<E>
-
containsAll
public boolean containsAll(XGettingCollection<? extends E> elements)
- Specified by:
containsAll
in interfaceXGettingCollection<E>
-
equals
public boolean equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
Description copied from interface:XGettingCollection
Returnstrue
if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)
yieldstrue
.- Specified by:
equals
in interfaceXGettingCollection<E>
-
equalsContent
public boolean equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
Description copied from interface:XGettingCollection
Returnstrue
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 inCollection
). 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 interfaceXGettingCollection<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 interfaceXGettingCollection<E>
-
except
public <C extends Consumer<? super E>> C except(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)
- Specified by:
except
in interfaceXGettingCollection<E>
-
union
public <C extends Consumer<? super E>> C union(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)
- Specified by:
union
in interfaceXGettingCollection<E>
-
copyTo
public <C extends Consumer<? super E>> C copyTo(C target)
- Specified by:
copyTo
in interfaceXGettingCollection<E>
-
filterTo
public <C extends Consumer<? super E>> C filterTo(C target, Predicate<? super E> predicate)
- Specified by:
filterTo
in interfaceXGettingCollection<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 interfaceXGettingCollection<E>
-
distinct
public <C extends Consumer<? super E>> C distinct(C target, Equalator<? super E> equalator)
- Specified by:
distinct
in interfaceXGettingCollection<E>
-
copySelection
public <C extends Consumer<? super E>> C copySelection(C target, long... indices)
- Specified by:
copySelection
in interfaceXGettingSequence<E>
-
listIterator
public ListIterator<E> listIterator()
- Specified by:
listIterator
in interfaceXGettingList<E>
-
listIterator
public ListIterator<E> listIterator(long index)
- Specified by:
listIterator
in interfaceXGettingList<E>
-
size
public long size()
- Specified by:
size
in interfaceSized
- Specified by:
size
in interfaceXGettingCollection<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 interfaceCapacityCarrying
- 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 interfaceCapacityCarrying
-
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 interfaceCapacityCarrying
-
view
public ConstList<E> view()
- Specified by:
view
in interfaceXGettingBag<E>
- Specified by:
view
in interfaceXGettingCollection<E>
- Specified by:
view
in interfaceXGettingList<E>
- Specified by:
view
in interfaceXGettingSequence<E>
- Specified by:
view
in interfaceXImmutableList<E>
-
view
public ConstList<E> view(long lowIndex, long highIndex)
- Specified by:
view
in interfaceXGettingList<E>
- Specified by:
view
in interfaceXGettingSequence<E>
- Specified by:
view
in interfaceXImmutableList<E>
-
range
public ConstList<E> range(long fromIndex, long toIndex)
- Specified by:
range
in interfaceXGettingList<E>
- Specified by:
range
in interfaceXGettingSequence<E>
- Specified by:
range
in interfaceXImmutableList<E>
-
toArray
public Object[] toArray()
- Specified by:
toArray
in interfaceXGettingCollection<E>
-
at
public E at(long index) throws ArrayIndexOutOfBoundsException
- Specified by:
at
in interfaceXGettingSequence<E>
- Throws:
ArrayIndexOutOfBoundsException
-
equals
@Deprecated public boolean equals(Object o)
Deprecated.Description copied from interface:XGettingCollection
Performs an equality comparison according to the specification inCollection
.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 asCollection
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 interfaceHashImmutable
- Specified by:
equals
in interfaceXGettingCollection<E>
- Overrides:
equals
in classObject
- 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 interfaceHashImmutable
- Specified by:
hashCode
in interfaceXGettingCollection<E>
- Overrides:
hashCode
in classObject
- 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 ConstList.OldConstList<E> old()
- Specified by:
old
in interfaceXGettingCollection<E>
- Specified by:
old
in interfaceXGettingList<E>
-
-