Class ListProcessor<E>
- java.lang.Object
-
- one.microstream.collections.ListProcessor<E>
-
- All Implemented Interfaces:
Iterable<E>,CapacityCarrying,ConsolidatableCollection,ExtendedBag<E>,ExtendedCollection<E>,ExtendedList<E>,ExtendedSequence<E>,OptimizableCollection,ReleasingCollection<E>,Sized,Truncateable,XGettingBag<E>,XGettingCollection<E>,XGettingList<E>,XGettingSequence<E>,XIndexIterable<E>,XIterable<E>,XJoinable<E>,XProcessingBag<E>,XProcessingCollection<E>,XProcessingList<E>,XProcessingSequence<E>,XRemovingBag<E>,XRemovingCollection<E>,XRemovingList<E>,XRemovingSequence<E>,Processable<E>,Clearable,Copyable
public final class ListProcessor<E> extends Object implements XProcessingList<E>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListProcessor.OldListProcessor<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.XIterable
XIterable.Executor<E>
-
Nested classes/interfaces inherited from interface one.microstream.collections.types.XProcessingList
XProcessingList.Factory<E>
-
-
Constructor Summary
Constructors Constructor Description ListProcessor(XProcessingList<E> list)
-
Method Summary
Modifier and Type Method Description booleanapplies(Predicate<? super E> predicate)Eat(long index)voidclear()Clears all elements from the collection while leaving the capacity as it is.longconsolidate()Consolidates the internal storage of this collection by discarding all elements of the internal storage that have become obsolete or otherwise unneeded anymore.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)ListProcessor<E>copy()Creates a true copy of this list which references th same elements in the same order as this list 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> other, Equalator<? super E> equalator, C target)Efetch()<C extends Consumer<? super E>>
CfilterTo(C target, Predicate<? super E> predicate)Efirst()Eget()Gets the first element in 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.XImmutableList<E>immure()Provides an instance of an immutable collection type with equal behavior and data as this instance.longindexBy(Predicate<? super E> predicate)longindexOf(E element)<C extends Consumer<? super E>>
Cintersect(XGettingCollection<? extends E> other, 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)<C extends Consumer<? super E>>
CmoveSelection(C target, long... indices)<C extends Consumer<? super E>>
CmoveTo(C target, Predicate<? super E> predicate)booleannullAllowed()booleannullContained()longnullRemove()ListProcessor.OldListProcessor<E>old()longoptimize()Optimizes internal memory usage by rebuilding the storage to only occupy as much memory as needed to store the currently contained elements in terms of the collection's current memory usage configuration (e.g.Epeek()Epick()Epinch()Epoll()Epop()<P extends Consumer<? super E>>
Pprocess(P procedure)SubListProcessor<E>range(long fromIndex, long toIndex)longremainingCapacity()Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.longremove(E element)longremoveAll(XGettingCollection<? extends E> elements)EremoveAt(long index)longremoveBy(Predicate<? super E> predicate)longremoveDuplicates()longremoveDuplicates(Equalator<? super E> equalator)booleanremoveOne(E element)ListProcessor<E>removeRange(long startIndex, long length)longremoveSelection(long[] indices)longretainAll(XGettingCollection<? extends E> elements)ListProcessor<E>retainRange(long startIndex, long length)Eretrieve(E element)EretrieveBy(Predicate<? super E> predicate)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)ListProcessor<E>toReversed()voidtruncate()Clears (and reinitializes if needed) this collection in the fastest possible way, i.e.<C extends Consumer<? super E>>
Cunion(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)ListView<E>view()SubListView<E>view(long fromIndex, long toIndex)-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, 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
-
ListProcessor
public ListProcessor(XProcessingList<E> list)
-
-
Method Detail
-
immure
public XImmutableList<E> immure()
Description copied from interface:XGettingListProvides an instance of an immutable collection type with equal behavior and data as this instance.If this instance already is of an immutable collection type, it returns itself.
- Specified by:
immurein interfaceXGettingBag<E>- Specified by:
immurein interfaceXGettingCollection<E>- Specified by:
immurein interfaceXGettingList<E>- Specified by:
immurein interfaceXGettingSequence<E>- Specified by:
immurein interfaceXProcessingBag<E>- Returns:
- an immutable copy of this collection instance.
-
equality
public Equalator<? super E> equality()
- Specified by:
equalityin interfaceXGettingCollection<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>
-
clear
public void clear()
Description copied from interface:XRemovingCollectionClears all elements from the collection while leaving the capacity as it is.- Specified by:
clearin interfaceClearable- Specified by:
clearin interfaceXRemovingCollection<E>
-
contains
public boolean contains(E element)
- Specified by:
containsin interfaceXGettingCollection<E>
-
nullAllowed
public boolean nullAllowed()
- Specified by:
nullAllowedin interfaceExtendedCollection<E>
-
nullContained
public boolean nullContained()
- Specified by:
nullContainedin interfaceXGettingCollection<E>
-
containsAll
public boolean containsAll(XGettingCollection<? extends E> elements)
- Specified by:
containsAllin 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.
-
copy
public ListProcessor<E> copy()
Description copied from interface:XGettingSequenceCreates a true copy of this list which references th same elements in the same order as this list does at the time the method is called. The elements themselves are NOT copied (no deep copying).
The type of the returned list is the same as of this list if possible (i.e.: a SubList can not meaningful return a true copy that references its elements but still is a SubList)- 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 interfaceXProcessingBag<E>- Specified by:
copyin interfaceXProcessingList<E>- Returns:
- a copy of this list
-
copySelection
public <C extends Consumer<? super E>> C copySelection(C target, long... indices)
- Specified by:
copySelectionin interfaceXGettingSequence<E>
-
filterTo
public <C extends Consumer<? super E>> C filterTo(C target, Predicate<? super E> predicate)
- Specified by:
filterToin interfaceXGettingCollection<E>
-
copyTo
public <C extends Consumer<? super E>> C copyTo(C target)
- Specified by:
copyToin interfaceXGettingCollection<E>
-
count
public long count(E element)
- Specified by:
countin interfaceXGettingCollection<E>
-
countBy
public long countBy(Predicate<? super E> predicate)
- Specified by:
countByin interfaceXGettingCollection<E>
-
distinct
public <C extends Consumer<? super E>> C distinct(C target, Equalator<? super E> equalator)
- Specified by:
distinctin interfaceXGettingCollection<E>
-
distinct
public <C extends Consumer<? super E>> C distinct(C target)
- Specified by:
distinctin interfaceXGettingCollection<E>
-
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 interfaceXGettingCollection<E>- Overrides:
equalsin classObject
-
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
-
except
public <C extends Consumer<? super E>> C except(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)
- Specified by:
exceptin interfaceXGettingCollection<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)
-
at
public E at(long index)
- Specified by:
atin interfaceXGettingSequence<E>
-
get
public E get()
Description copied from interface:XGettingSequenceGets the first element in the collection. This is a parameterless alias vorat(0).first() is an alias for this method for consistency reasons with last().- Specified by:
getin interfaceXGettingCollection<E>- Specified by:
getin interfaceXGettingSequence<E>- Returns:
- the first 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>
-
hashCode
@Deprecated public int hashCode()
Deprecated.- Specified by:
hashCodein interfaceXGettingCollection<E>- Overrides:
hashCodein classObject
-
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.
-
indexOf
public long indexOf(E element)
- Specified by:
indexOfin interfaceXGettingSequence<E>
-
indexBy
public long indexBy(Predicate<? super E> predicate)
- Specified by:
indexByin interfaceXGettingSequence<E>
-
intersect
public <C extends Consumer<? super E>> C intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)
- Specified by:
intersectin interfaceXGettingCollection<E>
-
isSorted
public boolean isSorted(Comparator<? super E> comparator)
- Specified by:
isSortedin interfaceXGettingSequence<E>
-
lastIndexBy
public long lastIndexBy(Predicate<? super E> predicate)
- Specified by:
lastIndexByin interfaceXGettingSequence<E>
-
lastIndexOf
public long lastIndexOf(E element)
- Specified by:
lastIndexOfin interfaceXGettingSequence<E>
-
listIterator
public ListIterator<E> listIterator()
- Specified by:
listIteratorin interfaceXGettingList<E>
-
listIterator
public ListIterator<E> listIterator(long index)
- Specified by:
listIteratorin interfaceXGettingList<E>
-
max
public E max(Comparator<? super E> comparator)
- Specified by:
maxin interfaceXGettingCollection<E>
-
maxIndex
public long maxIndex(Comparator<? super E> comparator)
- Specified by:
maxIndexin interfaceXGettingSequence<E>
-
min
public E min(Comparator<? super E> comparator)
- Specified by:
minin interfaceXGettingCollection<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.
-
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>
-
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
-
range
public SubListProcessor<E> range(long fromIndex, long toIndex)
- Specified by:
rangein interfaceXGettingList<E>- Specified by:
rangein interfaceXGettingSequence<E>
-
toArray
public Object[] toArray()
- Specified by:
toArrayin interfaceXGettingCollection<E>
-
toReversed
public ListProcessor<E> toReversed()
- Specified by:
toReversedin interfaceXGettingList<E>- Specified by:
toReversedin interfaceXGettingSequence<E>- Specified by:
toReversedin interfaceXProcessingList<E>- Specified by:
toReversedin interfaceXProcessingSequence<E>
-
union
public <C extends Consumer<? super E>> C union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)
- Specified by:
unionin interfaceXGettingCollection<E>
-
consolidate
public long consolidate()
Description copied from interface:XRemovingCollectionConsolidates the internal storage of this collection by discarding all elements of the internal storage that have become obsolete or otherwise unneeded anymore. (e.g.WeakReferenceentries whose reference has been cleared).If this is not possible or not needed in the concrete implementation, this method does nothing and returns 0.
- Specified by:
consolidatein interfaceConsolidatableCollection- Specified by:
consolidatein interfaceXRemovingCollection<E>- Returns:
- the number of discarded entries.
-
moveSelection
public <C extends Consumer<? super E>> C moveSelection(C target, long... indices)
- Specified by:
moveSelectionin interfaceXProcessingSequence<E>
-
moveTo
public <C extends Consumer<? super E>> C moveTo(C target, Predicate<? super E> predicate)
- Specified by:
moveToin interfaceXProcessingCollection<E>
-
process
public final <P extends Consumer<? super E>> P process(P procedure)
- Specified by:
processin interfaceProcessable<E>
-
removeBy
public long removeBy(Predicate<? super E> predicate)
- Specified by:
removeByin interfaceXProcessingCollection<E>
-
remove
public long remove(E element)
- Specified by:
removein interfaceXRemovingCollection<E>
-
removeAt
public E removeAt(long index)
- Specified by:
removeAtin interfaceXProcessingSequence<E>
-
removeAll
public long removeAll(XGettingCollection<? extends E> elements)
- Specified by:
removeAllin interfaceXRemovingCollection<E>
-
removeDuplicates
public long removeDuplicates(Equalator<? super E> equalator)
- Specified by:
removeDuplicatesin interfaceXProcessingCollection<E>
-
removeDuplicates
public long removeDuplicates()
- Specified by:
removeDuplicatesin interfaceXRemovingCollection<E>
-
fetch
public E fetch()
- Specified by:
fetchin interfaceXProcessingCollection<E>
-
pop
public E pop()
- Specified by:
popin interfaceXProcessingSequence<E>
-
pinch
public E pinch()
- Specified by:
pinchin interfaceXProcessingCollection<E>
-
pick
public E pick()
- Specified by:
pickin interfaceXProcessingSequence<E>
-
retrieve
public E retrieve(E element)
- Specified by:
retrievein interfaceXProcessingCollection<E>
-
retrieveBy
public E retrieveBy(Predicate<? super E> predicate)
- Specified by:
retrieveByin interfaceXProcessingCollection<E>
-
removeOne
public boolean removeOne(E element)
- Specified by:
removeOnein interfaceXRemovingCollection<E>
-
removeRange
public ListProcessor<E> removeRange(long startIndex, long length)
- Specified by:
removeRangein interfaceXRemovingSequence<E>
-
retainRange
public ListProcessor<E> retainRange(long startIndex, long length)
- Specified by:
retainRangein interfaceXRemovingSequence<E>
-
removeSelection
public long removeSelection(long[] indices)
- Specified by:
removeSelectionin interfaceXRemovingSequence<E>
-
retainAll
public long retainAll(XGettingCollection<? extends E> elements)
- Specified by:
retainAllin interfaceXRemovingCollection<E>
-
optimize
public long optimize()
Description copied from interface:XRemovingCollectionOptimizes internal memory usage by rebuilding the storage to only occupy as much memory as needed to store the currently contained elements in terms of the collection's current memory usage configuration (e.g. hash density).If this is not possible or not needed in the concreate implementation, this method does nothing.
Note that this method can consume a considerable amount of time depending on the implementation and should only be called intentionally and accurately when reducing occupied memory is needed.
- Specified by:
optimizein interfaceOptimizableCollection- Specified by:
optimizein interfaceXRemovingCollection<E>- Returns:
- the amount of elements that can be added before the internal storage has to be adjusted.
-
view
public ListView<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 interfaceXProcessingBag<E>
-
view
public SubListView<E> view(long fromIndex, long toIndex)
- Specified by:
viewin interfaceXGettingList<E>- Specified by:
viewin interfaceXGettingSequence<E>- Specified by:
viewin interfaceXProcessingSequence<E>
-
truncate
public void truncate()
Description copied from interface:XRemovingCollectionClears (and reinitializes if needed) this collection in the fastest possible way, i.e. by allocating a new and empty internal storage of default capacity. The collection will be empty after calling this method.- Specified by:
truncatein interfaceTruncateable- Specified by:
truncatein interfaceXRemovingCollection<E>
-
nullRemove
public long nullRemove()
- Specified by:
nullRemovein interfaceXRemovingCollection<E>
-
old
public ListProcessor.OldListProcessor<E> old()
- Specified by:
oldin interfaceXGettingCollection<E>- Specified by:
oldin interfaceXGettingList<E>
-
-