Class EqConstList<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.EqConstList<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,HashImmutable,Composition,Copyable,Immutable
public final class EqConstList<E> extends AbstractSimpleArrayCollection<E> implements XImmutableList<E>, Composition
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
Iteratorparadigm.- Version:
- 0.91, 2011-02-28
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classEqConstList.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 EqConstList(EqConstList<? extends E> original)EqConstList(Equalator<? super E> equalator, int initialCapacity)EqConstList(Equalator<? super E> equalator, E... elements)EqConstList(Equalator<? super E> equalator, E[] src, int srcStart, int srcLength)EqConstList(Equalator<? super E> equalator, XGettingCollection<? extends E> elements)
-
Method Summary
Modifier and Type Method Description booleanapplies(Predicate<? super E> predicate)Eat(long index)booleancontains(E element)booleancontainsAll(XGettingCollection<? extends E> elements)booleancontainsId(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 aPredicateimplementation that checks for object identity.booleancontainsSearched(Predicate<? super E> predicate)EqConstList<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)longcount(E element)longcountBy(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()booleanequals(Object o)Deprecated.booleanequals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)Returnstrueif the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)yieldstrue.booleanequalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)Returnstrueif 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)Efirst()Eget()Gets one element from the collection.inthashCode()Deprecated.booleanhasVolatileElements()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.EqConstList<E>immure()Always returns the already immutable collection instance itselflongindexBy(Predicate<? super E> predicate)longindexOf(E element)<C extends Consumer<? super E>>
Cintersect(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)booleanisEmpty()booleanisFull()Returns true if the current capacity cannot be increased any more.booleanisSorted(Comparator<? super E> comparator)<P extends Consumer<? super E>>
Piterate(P procedure)<P extends IndexedAcceptor<? super E>>
PiterateIndexed(P procedure)Iterator<E>iterator()<A> Ajoin(BiConsumer<? super E,? super A> joiner, A aggregate)Elast()longlastIndexBy(Predicate<? super E> predicate)longlastIndexOf(E element)ListIterator<E>listIterator()ListIterator<E>listIterator(long index)Emax(Comparator<? super E> comparator)longmaximumCapacity()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.longmaxIndex(Comparator<? super E> comparator)Emin(Comparator<? super E> comparator)longminIndex(Comparator<? super E> comparator)booleannullAllowed()booleannullContained()EqConstList.OldConstList<E>old()Epeek()Epoll()EqConstList<E>range(long fromIndex, long toIndex)longremainingCapacity()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)longscan(Predicate<? super E> predicate)Iterates through the collection and returns the index of the last element that the passedPredicateapplied to ("scanning").Esearch(Predicate<? super E> predicate)Eseek(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.longsize()Object[]toArray()E[]toArray(Class<E> type)EqConstList<E>toReversed()StringtoString()<C extends Consumer<? super E>>
Cunion(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)EqConstList<E>view()EqConstList<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 Detail
-
EqConstList
public EqConstList(EqConstList<? extends E> original) throws NullPointerException
- Throws:
NullPointerException
-
EqConstList
public EqConstList(Equalator<? super E> equalator, XGettingCollection<? extends E> elements) throws NullPointerException
- Throws:
NullPointerException
-
EqConstList
@SafeVarargs public EqConstList(Equalator<? super E> equalator, E... elements) throws NullPointerException
- Throws:
NullPointerException
-
-
Method Detail
-
equality
public Equalator<? super E> equality()
- Specified by:
equalityin interfaceXGettingCollection<E>
-
copy
public EqConstList<E> copy()
Description copied from interface:XGettingCollectionCreates 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:
copyin interfaceCopyable- Specified by:
copyin interfaceXGettingBag<E>- Specified by:
copyin interfaceXGettingCollection<E>- Specified by:
copyin interfaceXGettingList<E>- Specified by:
copyin interfaceXGettingSequence<E>- Specified by:
copyin interfaceXImmutableBag<E>- Specified by:
copyin interfaceXImmutableCollection<E>- Specified by:
copyin interfaceXImmutableList<E>- Specified by:
copyin interfaceXImmutableSequence<E>- Returns:
- a copy of this list
-
immure
public EqConstList<E> immure()
Description copied from interface:XImmutableListAlways returns the already immutable collection instance itselfFor spawning a copy of the collection instance, see
XImmutableCollection.copy()- Specified by:
immurein interfaceXGettingBag<E>- Specified by:
immurein interfaceXGettingCollection<E>- Specified by:
immurein interfaceXGettingList<E>- Specified by:
immurein interfaceXGettingSequence<E>- Specified by:
immurein interfaceXImmutableBag<E>- Specified by:
immurein interfaceXImmutableCollection<E>- Specified by:
immurein interfaceXImmutableList<E>- Specified by:
immurein interfaceXImmutableSequence<E>- Returns:
- a reference to the instance itself.
- See Also:
XImmutableCollection.copy()
-
toReversed
public EqConstList<E> toReversed()
- Specified by:
toReversedin interfaceXGettingList<E>- Specified by:
toReversedin interfaceXGettingSequence<E>- Specified by:
toReversedin interfaceXImmutableList<E>- Specified by:
toReversedin interfaceXImmutableSequence<E>
-
iterateIndexed
public final <P extends IndexedAcceptor<? super E>> P iterateIndexed(P procedure)
- Specified by:
iterateIndexedin interfaceXIndexIterable<E>
-
join
public final <A> A join(BiConsumer<? super E,? super A> joiner, A aggregate)
-
count
public long count(E element)
- Specified by:
countin interfaceXGettingCollection<E>
-
countBy
public long countBy(Predicate<? super E> predicate)
- Specified by:
countByin interfaceXGettingCollection<E>
-
indexOf
public long indexOf(E element)
- Specified by:
indexOfin interfaceXGettingSequence<E>
-
indexBy
public long indexBy(Predicate<? super E> predicate)
- Specified by:
indexByin interfaceXGettingSequence<E>
-
lastIndexOf
public long lastIndexOf(E element)
- Specified by:
lastIndexOfin interfaceXGettingSequence<E>
-
lastIndexBy
public long lastIndexBy(Predicate<? super E> predicate)
- Specified by:
lastIndexByin interfaceXGettingSequence<E>
-
maxIndex
public long maxIndex(Comparator<? super E> comparator)
- Specified by:
maxIndexin interfaceXGettingSequence<E>
-
minIndex
public long minIndex(Comparator<? super E> comparator)
- Specified by:
minIndexin interfaceXGettingSequence<E>
-
scan
public long scan(Predicate<? super E> predicate)
Description copied from interface:XGettingSequenceIterates through the collection and returns the index of the last element that the passedPredicateapplied to ("scanning").- Specified by:
scanin interfaceXGettingSequence<E>- Returns:
- the index of the last positively tested element.
-
get
public E get()
Description copied from interface:XGettingCollectionGets 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:
getin interfaceXGettingCollection<E>- Specified by:
getin interfaceXGettingSequence<E>- Returns:
- the first / any element.
- See Also:
XGettingSequence.at(long),XGettingSequence.first(),XGettingSequence.last()
-
first
public E first()
- Specified by:
firstin interfaceXGettingSequence<E>
-
last
public E last()
- Specified by:
lastin interfaceXGettingSequence<E>
-
poll
public E poll()
- Specified by:
pollin interfaceXGettingSequence<E>
-
peek
public E peek()
- Specified by:
peekin interfaceXGettingSequence<E>
-
seek
public E seek(E sample)
Description copied from interface:XGettingCollectionReturns 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:
seekin interfaceXGettingCollection<E>
-
search
public E search(Predicate<? super E> predicate)
- Specified by:
searchin interfaceXGettingCollection<E>
-
max
public E max(Comparator<? super E> comparator)
- Specified by:
maxin interfaceXGettingCollection<E>
-
min
public E min(Comparator<? super E> comparator)
- Specified by:
minin interfaceXGettingCollection<E>
-
hasVolatileElements
public boolean hasVolatileElements()
Description copied from interface:XGettingCollectionTells 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 areWeakReferenceofSoftReferenceor implementations of collection entries that remove the element contained in an entry by some means outside the collection.
Note thatWeakReferenceinstances 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:
hasVolatileElementsin interfaceExtendedCollection<E>- Specified by:
hasVolatileElementsin interfaceXGettingCollection<E>- Returns:
trueif the collection contains volatile elements.
-
nullAllowed
public boolean nullAllowed()
- Specified by:
nullAllowedin interfaceExtendedCollection<E>
-
isSorted
public boolean isSorted(Comparator<? super E> comparator)
- Specified by:
isSortedin interfaceXGettingSequence<E>
-
containsSearched
public boolean containsSearched(Predicate<? super E> predicate)
- Specified by:
containsSearchedin interfaceXGettingCollection<E>
-
applies
public boolean applies(Predicate<? super E> predicate)
- Specified by:
appliesin interfaceXGettingCollection<E>
-
nullContained
public boolean nullContained()
- Specified by:
nullContainedin interfaceXGettingCollection<E>
-
containsId
public boolean containsId(E element)
Description copied from interface:XGettingCollectionSpecial 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 aPredicateimplementation that checks for object identity. The only difference is a performance and usability advantage- Specified by:
containsIdin 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:
containsin interfaceXGettingCollection<E>
-
containsAll
public boolean containsAll(XGettingCollection<? extends E> elements)
- Specified by:
containsAllin interfaceXGettingCollection<E>
-
equals
public boolean equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
Description copied from interface:XGettingCollectionReturnstrueif the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)yieldstrue.- Specified by:
equalsin interfaceXGettingCollection<E>
-
equalsContent
public boolean equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
Description copied from interface:XGettingCollectionReturnstrueif 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:
equalsContentin interfaceXGettingCollection<E>equalator- the equalator to use to determine the equality of each element- Returns:
trueif 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:
intersectin interfaceXGettingCollection<E>
-
except
public <C extends Consumer<? super E>> C except(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)
- Specified by:
exceptin interfaceXGettingCollection<E>
-
union
public <C extends Consumer<? super E>> C union(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)
- Specified by:
unionin interfaceXGettingCollection<E>
-
copyTo
public <C extends Consumer<? super E>> C copyTo(C target)
- Specified by:
copyToin interfaceXGettingCollection<E>
-
filterTo
public <C extends Consumer<? super E>> C filterTo(C target, Predicate<? super E> predicate)
- Specified by:
filterToin 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:
distinctin interfaceXGettingCollection<E>
-
distinct
public <C extends Consumer<? super E>> C distinct(C target, Equalator<? super E> equalator)
- Specified by:
distinctin interfaceXGettingCollection<E>
-
copySelection
public <C extends Consumer<? super E>> C copySelection(C target, long... indices)
- Specified by:
copySelectionin interfaceXGettingSequence<E>
-
listIterator
public ListIterator<E> listIterator()
- Specified by:
listIteratorin interfaceXGettingList<E>
-
listIterator
public ListIterator<E> listIterator(long index)
- Specified by:
listIteratorin interfaceXGettingList<E>
-
size
public long size()
- Specified by:
sizein interfaceSized- Specified by:
sizein interfaceXGettingCollection<E>
-
maximumCapacity
public long maximumCapacity()
Description copied from interface:CapacityCarryingReturns 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:
maximumCapacityin interfaceCapacityCarrying- Returns:
- the maximum amount of elements this carrier instance can contain.
-
isFull
public boolean isFull()
Description copied from interface:CapacityCarryingReturns true if the current capacity cannot be increased any more.- Specified by:
isFullin interfaceCapacityCarrying
-
remainingCapacity
public long remainingCapacity()
Description copied from interface:CapacityCarryingReturns the amount of elements this carrier instance can collect before reaching its maximimum capacity.- Specified by:
remainingCapacityin interfaceCapacityCarrying
-
view
public EqConstList<E> view()
- Specified by:
viewin interfaceXGettingBag<E>- Specified by:
viewin interfaceXGettingCollection<E>- Specified by:
viewin interfaceXGettingList<E>- Specified by:
viewin interfaceXGettingSequence<E>- Specified by:
viewin interfaceXImmutableList<E>
-
view
public EqConstList<E> view(long lowIndex, long highIndex)
- Specified by:
viewin interfaceXGettingList<E>- Specified by:
viewin interfaceXGettingSequence<E>- Specified by:
viewin interfaceXImmutableList<E>
-
range
public EqConstList<E> range(long fromIndex, long toIndex)
- Specified by:
rangein interfaceXGettingList<E>- Specified by:
rangein interfaceXGettingSequence<E>- Specified by:
rangein interfaceXImmutableList<E>
-
toArray
public Object[] toArray()
- Specified by:
toArrayin interfaceXGettingCollection<E>
-
at
public E at(long index) throws ArrayIndexOutOfBoundsException
- Specified by:
atin interfaceXGettingSequence<E>- Throws:
ArrayIndexOutOfBoundsException
-
equals
@Deprecated public boolean equals(Object o)
Deprecated.Description copied from interface:XGettingCollectionPerforms 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 asCollectiondefines 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:
equalsin interfaceHashImmutable- Specified by:
equalsin interfaceXGettingCollection<E>- Overrides:
equalsin classObject- Parameters:
o- the reference object with which to compare.- Returns:
trueif this object can be treated as the same as other,falseotherwise.- See Also:
HashImmutable.hashCode()
-
hashCode
@Deprecated public int hashCode()
Deprecated.Description copied from interface:HashImmutableMarker declaration to indicate that for classes of this type,Object.hashCode()can be properly used.- Specified by:
hashCodein interfaceHashImmutable- Specified by:
hashCodein interfaceXGettingCollection<E>- Overrides:
hashCodein 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 EqConstList.OldConstList<E> old()
- Specified by:
oldin interfaceXGettingCollection<E>- Specified by:
oldin interfaceXGettingList<E>
-
-