Class ArrayCollector<E>
- All Implemented Interfaces:
Iterable<E>,Consumer<E>,CapacityCarrying,CapacityExtendable,ConsolidatableCollection,ExtendedBag<E>,ExtendedCollection<E>,ExtendedList<E>,ExtendedSequence<E>,OptimizableCollection,ReleasingCollection<E>,Sized,Truncateable,Sortable<E>,SortableProcedure<E>,XAddGetCollection<E>,XAddingBag<E>,XAddingCollection<E>,XAddingList<E>,XAddingSequence<E>,XBag<E>,XBasicList<E>,XBasicSequence<E>,XCollection<E>,XDecreasingList<E>,XDecreasingSequence<E>,XExpandingList<E>,XExpandingSequence<E>,XExtendingList<E>,XExtendingSequence<E>,XGettingBag<E>,XGettingCollection<E>,XGettingList<E>,XGettingSequence<E>,XIncreasingList<E>,XIncreasingSequence<E>,XIndexIterable<E>,XInputtingList<E>,XInputtingSequence<E>,XInsertingSequence<E>,XIterable<E>,XJoinable<E>,XList<E>,XOrderingSequence<E>,XPrependingList<E>,XPrependingSequence<E>,XPreputtingList<E>,XPreputtingSequence<E>,XProcessingBag<E>,XProcessingCollection<E>,XProcessingList<E>,XProcessingSequence<E>,XPutGetBag<E>,XPutGetCollection<E>,XPutGetList<E>,XPutGetSequence<E>,XPuttingBag<E>,XPuttingCollection<E>,XPuttingList<E>,XPuttingSequence<E>,XRemovingBag<E>,XRemovingCollection<E>,XRemovingList<E>,XRemovingSequence<E>,XReplacingBag<E>,XReplacingCollection<E>,XSequence<E>,XSettingList<E>,XSettingSequence<E>,XSortableSequence<E>,Processable<E>,Clearable,Copyable
public final class ArrayCollector<E> extends AbstractSimpleArrayCollection<E> implements XList<E>
XList.
This array-backed implementation is optimal for all needs of a list that do not require frequent structural
modification (insert or remove) of single elements before the end of the list.
It is recommended to use this implementation as default list type until concrete performance deficiencies are
identified. If used properly (e.g. always ensure enough capacity, make use of batch procedures like
inputAll(long, Object...), removeRange(long, long), etc.), this implementation has equal or
massively superior performance to linked-list implementation is most cases.
This implementation is NOT synchronized and thus should only be used by a
single thread or in a thread-safe manner (i.e. read-only as soon as multiple threads access it).
See SynchList wrapper class to use a list in a synchronized manner.
Note that this List implementation does NOT keep track of modification count as JDK's collection implementations do
(and thus never throws a ConcurrentModificationException), for two reasons:
1.) It is already explicitly declared thread-unsafe and for single-thread (or thread-safe)
use only.
2.) The common modCount-concurrency exception behavior ("failfast") has buggy and inconsistent behavior by
throwing ConcurrentModificationException even in single thread use, i.e. when iterating over a collection
and removing more than one element of it without using the iterator's method.
Current conclusion is that the JDK's failfast implementations buy unneeded (and even unreliable as stated by
official guides) concurrency modification recognition at the cost of performance loss and even a bug when already
used in a thread-safe manner.
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.9, 2011-02-06
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classArrayCollector.OldArrayCollector<E>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.XBag
XBag.Factory<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XBasicSequence
XBasicSequence.Factory<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingList
XGettingList.Factory<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingSequence
XGettingSequence.Factory<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XInputtingList
XInputtingList.Factory<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.XList
XList.Creator<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XProcessingList
XProcessingList.Factory<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XProcessingSequence
XProcessingSequence.Factory<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XPutGetList
XPutGetList.Factory<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XReplacingBag
XReplacingBag.Factory<E> -
Constructor Summary
Constructors Constructor Description ArrayCollector()ArrayCollector(E... elements)ArrayCollector(E[] elements, int size)ArrayCollector(ArrayCollector<? extends E> original) -
Method Summary
Modifier and Type Method Description voidaccept(E element)booleanadd(E element)Adds the passed element.ArrayCollector<E>addAll(E... elements)ArrayCollector<E>addAll(E[] elements, int offset, int length)ArrayCollector<E>addAll(XGettingCollection<? extends E> elements)booleanapplies(Predicate<? super E> predicate)Tests each element of the collection on the given 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)Checks if the given element is contained in the collection.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)ArrayCollector<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)Iterates through all the elements of the given indices and calls theConsumer.accept(Object)on the targetConsumer.<C extends Consumer<? super E>>
CcopyTo(C target)CallsConsumer.accept(Object)on the targetConsumerfor all the elements of this collection.longcount(E element)Count how many times this element matches another element in the collection using theEqualator.longcountBy(Predicate<? super E> predicate)Count how many matches are found using the given predicate on each element of the collection.longcurrentCapacity()Returns the current amount of elements this instance can hold before a storage rebuild becomes necessary.<C extends Consumer<? super E>>
Cdistinct(C target)CallsConsumer.accept(Object)on the targetConsumerfor all the unique/distinct elements of this collection.<C extends Consumer<? super E>>
Cdistinct(C target, Equalator<? super E> equalator)CallsConsumer.accept(Object)on the targetConsumerfor all the unique/distinct elements of this collection.ArrayCollector<E>ensureCapacity(long minCapacity)ArrayCollector<E>ensureFreeCapacity(long requiredFreeCapacity)Ensures that the next minimalFreeCapacity elements can be actually added in a fast way, meaning for example no internal storage rebuild will be necessary.Equalator<? super E>equality()booleanequals(Object o)Deprecated.booleanequals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)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)CallsConsumer.accept(Object)on the targetConsumerfor each element of this collection that is not contained in the other collection (through the given equalator).Efetch()ArrayCollector<E>fill(long offset, long length, E element)Fills all slots from the offset to the offset+length with the given element, regardless of whether or not a slot isnull.<C extends Consumer<? super E>>
CfilterTo(C target, Predicate<? super E> predicate)CallsConsumer.accept(Object)on the targetConsumerfor all the elements of this collection which testtrueon the given predicate.Efirst()Gets first element or throwsIndexOutOfBoundsExceptionif the collection is empty.Eget()Gets one element from the collection.E[]getArray()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)Iterates forwards through the collection and returns the index of the first element that the passed {link Predicate} applies to immediately.
Stops iterating on the first element that the predicate applies to.longindexOf(E element)booleaninput(long index, E element)longinputAll(long index, E... elements)longinputAll(long index, E[] elements, int offset, int length)longinputAll(long index, XGettingCollection<? extends E> elements)booleaninsert(long index, E element)longinsertAll(long index, E... elements)longinsertAll(long index, E[] elements, int offset, int length)longinsertAll(long index, XGettingCollection<? extends E> elements)protected intinternalCountingAddAll(E[] elements)protected intinternalCountingAddAll(E[] elements, int offset, int length)protected intinternalCountingAddAll(XGettingCollection<? extends E> elements)protected intinternalCountingPutAll(E[] elements)protected intinternalCountingPutAll(E[] elements, int offset, int length)protected intinternalCountingPutAll(XGettingCollection<? extends E> elements)protected int[]internalGetSectionIndices()Defines the array sections in which the collection's elements are organized by one or more pairs of indices in the order corresponding to the collection's logical order of its contained elements.protected E[]internalGetStorageArray()This is an internal shortcut method to provide fast access to the various array-backed list implementations' storage arrays.
The purpose of this method is to allow access to the array only for read-only procedures, never for modifying accesses.protected intinternalSize()<C extends Consumer<? super E>>
Cintersect(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)Tests equality between each element of the two lists and callsConsumer.accept(Object)on the targetConsumerfor the equal elements.
Therefore it effectively creates a mathematical intersection between the two collections.booleanisEmpty()booleanisFull()Returns true if the current capacity cannot be increased any more.booleanisSorted(Comparator<? super E> comparator)Tests if the collection is sorted according to the given comparator.<P extends Consumer<? super E>>
Piterate(P procedure)Executes the given procedure for each element of theXIterableuntil all elements have been processed or the action throws an exception.<P extends IndexedAcceptor<? super E>>
PiterateIndexed(P procedure)Iterates over elements with theIndexedAcceptorto use not only the element itself but also its coherent index.Iterator<E>iterator()<A> Ajoin(BiConsumer<? super E,? super A> joiner, A aggregate)Iterates over all elements of the collections and calls the joiner with each element and the aggregate.Elast()Gets last element or throwsIndexOutOfBoundsExceptionif the collection is empty.longlastIndexBy(Predicate<? super E> predicate)Iterates backwards through the collection and returns the index of the last element that the passedPredicateapplies to immediately.
Stops iterating on the first element that the predicate applies to.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)booleannullAdd()booleannullAllowed()Defines if null-elements are allowed inside the collection or not.booleannullContained()booleannullInput(long index)booleannullInsert(long index)booleannullPrepend()booleannullPreput()booleannullPut()longnullRemove()ArrayCollector.OldArrayCollector<E>old()longoptimize()Optimizes the internal storage of this collection and returns the storage size of the collection after the process is complete.Epeek()Gets last element or null if the collection is empty.Epick()Epinch()Epoll()Gets first element or null if the collection is empty.Epop()booleanprepend(E element)ArrayCollector<E>prependAll(E... elements)ArrayCollector<E>prependAll(E[] elements, int srcStartIndex, int srcLength)ArrayCollector<E>prependAll(XGettingCollection<? extends E> elements)booleanpreput(E element)ArrayCollector<E>preputAll(E... elements)ArrayCollector<E>preputAll(E[] elements, int offset, int length)ArrayCollector<E>preputAll(XGettingCollection<? extends E> elements)<P extends Consumer<? super E>>
Pprocess(P procedure)booleanput(E element)Adds the specified element to this collection if it is not already present (optional operation).ArrayCollector<E>putAll(E... elements)Adds the specified elements to this collection if it is not already present (optional operation).ArrayCollector<E>putAll(E[] elements, int offset, int length)Adds the specified elements to this collection if it is not already present (optional operation).
Only the elements with indizes from the srcStartIndex to the srcStartIndex+srcLength are put in the collection.ArrayCollector<E>putAll(XGettingCollection<? extends E> elements)Adds the specified elements to this collection if it is not already present (optional operation).SubList<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)ArrayCollector<E>removeRange(long startIndex, long length)longremoveSelection(long[] indices)longreplace(E element, E replacement)longreplace(Predicate<? super E> predicate, E substitute)longreplaceAll(XGettingCollection<? extends E> elements, E replacement)booleanreplaceOne(E element, E replacement)Replaces the first element that is equal to the given element with the replacement and then returns true.booleanreplaceOne(Predicate<? super E> predicate, E substitute)longretainAll(XGettingCollection<? extends E> elements)Removing all elements except the ones contained in the given elements-collection.ArrayCollector<E>retainRange(long startIndex, long length)Removing all elements but the ones from the offset (basically start index) to the offset+length (end index).Eretrieve(E element)EretrieveBy(Predicate<? super E> predicate)ArrayCollector<E>reverse()Reverses the order of its own elements and returns itself.<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)Returns the first contained element matching the passed 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.booleanset(long index, E element)ArrayCollector<E>set(long offset, E[] src, int srcIndex, int srcLength)ArrayCollector<E>set(long offset, XGettingSequence<? extends E> elements, long elementsOffset, long elementsLength)ArrayCollector<E>setAll(long offset, E... elements)ArrayCollector<E>setArray(E[] array, int size)voidsetFirst(E element)EsetGet(long index, E element)voidsetLast(E element)ArrayCollector<E>shiftBy(long sourceIndex, long distance)Moves the element from the sourceIndex in the sequence to a higher index position.
All other elements are possibly moved to create the empty slot for the shifting element.ArrayCollector<E>shiftBy(long sourceIndex, long distance, long length)Moves multiple elements from the sourceIndex in the sequence to a higher index position.
All other elements are possibly moved to create the empty slot for the shifting elements.ArrayCollector<E>shiftTo(long sourceIndex, long targetIndex)Moves the element from the sourceIndex in the sequence to the targetIndex.
All other elements are possibly moved to create the empty slot for the shifting element.ArrayCollector<E>shiftTo(long sourceIndex, long targetIndex, long length)Moves multiple elements from the sourceIndex in the sequence to the targetIndex.
All other elements are possibly moved to create the empty slot for the shifting element.longsize()ArrayCollector<E>sort(Comparator<? super E> comparator)Sorts this collection according to the given comparator and returns itself.longsubstitute(Function<? super E,? extends E> mapper)longsubstitute(Predicate<? super E> predicate, Function<E,E> mapper)ArrayCollector<E>swap(long indexA, long indexB)ArrayCollector<E>swap(long indexA, long indexB, long length)Object[]toArray()Returns an array containing all of the elements in this collection.E[]toArray(Class<E> type)Returns a typed array containing all of the elements in this collection.ArrayCollector<E>toReversed()Creates a newXBasicListwith the reversed order of elements.StringtoString()voidtruncate()Clears (and reinitializes if needed) this collection in the fastest possible way, i.e.<C extends Consumer<? super E>>
Cunion(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)CallsConsumer.accept(Object)on the targetConsumerfor all the elements of this collection.ListView<E>view()Creates a view of this collection and returns it.SubListView<E>view(long fromIndex, long toIndex)Creates a sub-view of this collection and returns it.Methods inherited from class one.microstream.collections.AbstractSimpleArrayCollection
internalGetStorageArrayMethods inherited from class one.microstream.collections.AbstractArrayCollection
marker, newArray, newArray, pow2BoundMaxedMethods inherited from class one.microstream.collections.AbstractExtendedCollection
ensureFreeArrayCapacity, validateIndexMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface one.microstream.collections.interfaces.CapacityExtendable
currentFreeCapacity
-
Constructor Details
-
ArrayCollector
public ArrayCollector() -
ArrayCollector
- Throws:
NullPointerException
-
ArrayCollector
- Throws:
NullPointerException
-
ArrayCollector
-
-
Method Details
-
getArray
-
equality
- Specified by:
equalityin interfaceXGettingCollection<E>
-
internalCountingAddAll
- Specified by:
internalCountingAddAllin classAbstractExtendedCollection<E>- Throws:
UnsupportedOperationException
-
internalCountingAddAll
protected int internalCountingAddAll(E[] elements, int offset, int length) throws UnsupportedOperationException- Specified by:
internalCountingAddAllin classAbstractExtendedCollection<E>- Throws:
UnsupportedOperationException
-
internalCountingAddAll
protected int internalCountingAddAll(XGettingCollection<? extends E> elements) throws UnsupportedOperationException- Specified by:
internalCountingAddAllin classAbstractExtendedCollection<E>- Throws:
UnsupportedOperationException
-
internalCountingPutAll
- Specified by:
internalCountingPutAllin classAbstractExtendedCollection<E>- Throws:
UnsupportedOperationException
-
internalCountingPutAll
protected int internalCountingPutAll(E[] elements, int offset, int length) throws UnsupportedOperationException- Specified by:
internalCountingPutAllin classAbstractExtendedCollection<E>- Throws:
UnsupportedOperationException
-
internalCountingPutAll
protected int internalCountingPutAll(XGettingCollection<? extends E> elements) throws UnsupportedOperationException- Specified by:
internalCountingPutAllin classAbstractExtendedCollection<E>- Throws:
UnsupportedOperationException
-
setArray
-
internalGetStorageArray
Description copied from class:AbstractSimpleArrayCollectionThis is an internal shortcut method to provide fast access to the various array-backed list implementations' storage arrays.
The purpose of this method is to allow access to the array only for read-only procedures, never for modifying accesses.The returned array is expected to contain the elements of the list in simple order from index 0 on to index (size - 1), so for example an array-backed ring list (queue) can NOT (reasonably) extend this class.
- Specified by:
internalGetStorageArrayin classAbstractSimpleArrayCollection<E>- Returns:
- the storage array used by the list, containing all elements in straight order.
-
internalSize
protected int internalSize()- Specified by:
internalSizein classAbstractSimpleArrayCollection<E>
-
internalGetSectionIndices
protected int[] internalGetSectionIndices()Description copied from class:AbstractSectionedArrayCollectionDefines the array sections in which the collection's elements are organized by one or more pairs of indices in the order corresponding to the collection's logical order of its contained elements.Examples:
The trivial example would be {0,size} in case of standard sized array collections.
An example for actual sectioning would be {i,array.length - 1, 0,i - 1} in case of a ring buffer list comprised of two sections: one ranging from index i to array.length - 1 (with the oldest element located at i) and one ranging from 0 to i - 1 (with the newest element located at i - 1).- Specified by:
internalGetSectionIndicesin classAbstractSectionedArrayCollection<E>- Returns:
- a list of index pairs defining all sections of the storage array in logical order.
-
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 interfaceXAddGetCollection<E>- Specified by:
copyin interfaceXBag<E>- Specified by:
copyin interfaceXBasicList<E>- Specified by:
copyin interfaceXBasicSequence<E>- Specified by:
copyin interfaceXCollection<E>- Specified by:
copyin interfaceXDecreasingList<E>- Specified by:
copyin interfaceXDecreasingSequence<E>- Specified by:
copyin interfaceXGettingBag<E>- Specified by:
copyin interfaceXGettingCollection<E>- Specified by:
copyin interfaceXGettingList<E>- Specified by:
copyin interfaceXGettingSequence<E>- Specified by:
copyin interfaceXIncreasingList<E>- Specified by:
copyin interfaceXIncreasingSequence<E>- Specified by:
copyin interfaceXList<E>- Specified by:
copyin interfaceXProcessingBag<E>- Specified by:
copyin interfaceXProcessingList<E>- Specified by:
copyin interfaceXPutGetCollection<E>- Specified by:
copyin interfaceXPutGetList<E>- Specified by:
copyin interfaceXPutGetSequence<E>- Specified by:
copyin interfaceXReplacingBag<E>- Specified by:
copyin interfaceXSequence<E>- Specified by:
copyin interfaceXSettingList<E>- Specified by:
copyin interfaceXSettingSequence<E>- Specified by:
copyin interfaceXSortableSequence<E>- Returns:
- a copy of this list
-
immure
Description copied from interface:XGettingCollectionProvides 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.
-
toReversed
Description copied from interface:XBasicListCreates a newXBasicListwith the reversed order of elements.This method creates a new collection and does not change the existing collection.
Furthermore changes to the reversed collection do not reflect to the original.- Specified by:
toReversedin interfaceXBasicList<E>- Specified by:
toReversedin interfaceXBasicSequence<E>- Specified by:
toReversedin interfaceXDecreasingList<E>- Specified by:
toReversedin interfaceXDecreasingSequence<E>- Specified by:
toReversedin interfaceXGettingList<E>- Specified by:
toReversedin interfaceXGettingSequence<E>- Specified by:
toReversedin interfaceXIncreasingList<E>- Specified by:
toReversedin interfaceXIncreasingSequence<E>- Specified by:
toReversedin interfaceXList<E>- Specified by:
toReversedin interfaceXProcessingList<E>- Specified by:
toReversedin interfaceXProcessingSequence<E>- Specified by:
toReversedin interfaceXPutGetList<E>- Specified by:
toReversedin interfaceXPutGetSequence<E>- Specified by:
toReversedin interfaceXSequence<E>- Specified by:
toReversedin interfaceXSettingList<E>- Specified by:
toReversedin interfaceXSettingSequence<E>- Specified by:
toReversedin interfaceXSortableSequence<E>- Returns:
- new reversed collection
-
toArray
Description copied from interface:XGettingCollectionReturns a typed array containing all of the elements in this collection.The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.
This method acts as bridge between MicroStream-based collections and Java-native-based APIs.
- Specified by:
toArrayin interfaceXGettingCollection<E>- Returns:
- a typed array containing all of the elements in this collection
-
iterate
Description copied from interface:XIterableExecutes the given procedure for each element of theXIterableuntil all elements have been processed or the action throws an exception. Unless otherwise specified by the implementing class, procedures are performed in the order of iteration (if an iteration order is specified). Exceptions thrown by the procedure are relayed to the caller.
Should be identical toIterable.forEach(Consumer). -
join
Description copied from interface:XJoinableIterates over all elements of the collections and calls the joiner with each element and the aggregate. -
iterateIndexed
Description copied from interface:XIndexIterableIterates over elements with theIndexedAcceptorto use not only the element itself but also its coherent index.- Specified by:
iterateIndexedin interfaceXIndexIterable<E>- Type Parameters:
P- type of procedure- Parameters:
procedure- which is executed when iterating- Returns:
- Given procedure
-
count
Description copied from interface:XGettingCollectionCount how many times this element matches another element in the collection using theEqualator.- Specified by:
countin interfaceXGettingCollection<E>- Parameters:
element- to count- Returns:
- Amount of matches
-
countBy
Description copied from interface:XGettingCollectionCount how many matches are found using the given predicate on each element of the collection.- Specified by:
countByin interfaceXGettingCollection<E>- Parameters:
predicate- defines which elements are counted and which are not- Returns:
- Amount of matches
-
indexOf
- Specified by:
indexOfin interfaceXGettingSequence<E>
-
indexBy
Description copied from interface:XGettingSequenceIterates forwards through the collection and returns the index of the first element that the passed {link Predicate} applies to immediately.
Stops iterating on the first element that the predicate applies to.Basically the opposite of
XGettingSequence.lastIndexBy(Predicate)- Specified by:
indexByin interfaceXGettingSequence<E>- Parameters:
predicate- to define a valid element- Returns:
- The index of the first positively tested element.
-
lastIndexOf
- Specified by:
lastIndexOfin interfaceXGettingSequence<E>
-
lastIndexBy
Description copied from interface:XGettingSequenceIterates backwards through the collection and returns the index of the last element that the passedPredicateapplies to immediately.
Stops iterating on the first element that the predicate applies to.Basically the opposite of
XGettingSequence.indexBy(Predicate).
Similar but not the same asXGettingSequence.scan(Predicate), sincescaniterates through all elements.- Specified by:
lastIndexByin interfaceXGettingSequence<E>- Parameters:
predicate- to define a valid element- Returns:
- the index of the last positively tested element.
-
maxIndex
- Specified by:
maxIndexin interfaceXGettingSequence<E>
-
minIndex
- Specified by:
minIndexin interfaceXGettingSequence<E>
-
scan
Description copied from interface:XGettingSequenceIterates through the collection and returns the index of the last element that the passedPredicateapplied to ("scanning").In order to find the last element, this method must iterate over all elements of the collection (opposed to
XGettingSequence.indexBy(Predicate)andXGettingSequence.lastIndexBy(Predicate)).Iteration can be safely canceled with a
ThrowBreak(X.BREAK)- Specified by:
scanin interfaceXGettingSequence<E>- Parameters:
predicate- to define a valid element- Returns:
- the index of the last positively tested element.
-
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
Description copied from interface:XGettingSequenceGets first element or throwsIndexOutOfBoundsExceptionif the collection is empty.Is an alias for
XGettingSequence.get().- Specified by:
firstin interfaceXGettingSequence<E>- Returns:
- First element
-
last
Description copied from interface:XGettingSequenceGets last element or throwsIndexOutOfBoundsExceptionif the collection is empty.- Specified by:
lastin interfaceXGettingSequence<E>- Returns:
- Last element
-
poll
Description copied from interface:XGettingSequenceGets first element or null if the collection is empty.- Specified by:
pollin interfaceXGettingSequence<E>- Returns:
- First element or null
-
peek
Description copied from interface:XGettingSequenceGets last element or null if the collection is empty.
This behaves like peeking on a stack without pop.- Specified by:
peekin interfaceXGettingSequence<E>- Returns:
- Last element or null
-
seek
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>- Parameters:
sample- to seek in the collection- Returns:
- the first contained element matching the passed sample
-
search
Description copied from interface:XGettingCollectionReturns the first contained element matching the passed predicate.- Specified by:
searchin interfaceXGettingCollection<E>- Parameters:
predicate- defines which element is searched- Returns:
- Matching element
-
max
- Specified by:
maxin interfaceXGettingCollection<E>
-
min
- Specified by:
minin interfaceXGettingCollection<E>
-
hasVolatileElements
public boolean hasVolatileElements()Description copied from interface:ExtendedCollectionTells 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()Description copied from interface:ExtendedCollectionDefines if null-elements are allowed inside the collection or not.- Specified by:
nullAllowedin interfaceExtendedCollection<E>- Returns:
trueif null is allowed inside the collection;falseif not
-
isSorted
Description copied from interface:XGettingSequenceTests if the collection is sorted according to the given comparator.- Specified by:
isSortedin interfaceXGettingSequence<E>- Parameters:
comparator- defines if elements are sorted- Returns:
- true if it sorted, false if not
-
containsSearched
- Specified by:
containsSearchedin interfaceXGettingCollection<E>
-
applies
Description copied from interface:XGettingCollectionTests each element of the collection on the given predicate.- Specified by:
appliesin interfaceXGettingCollection<E>- Parameters:
predicate- that's tested on each element.- Returns:
- If all elements test successfully, true is returned. Otherwise (if at least one test has failed), false is returned.
-
nullContained
public boolean nullContained()- Specified by:
nullContainedin interfaceXGettingCollection<E>
-
containsId
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 exactly the given element.
-
contains
Description copied from interface:XGettingCollectionChecks if the given element is contained in the collection.
In contrast to theXGettingCollection.containsId(Object)method, this method uses the internalEqualatordefined by the collection itself.- Specified by:
containsin interfaceXGettingCollection<E>- Parameters:
element- to be searched in the collection- Returns:
- Whether this collection contains the given element as specified by the
Equalator.
-
containsAll
- Specified by:
containsAllin interfaceXGettingCollection<E>- Parameters:
elements- to be searched in the collection.- Returns:
- Whether this collection contains all given elements as specified by the
Equalator.
-
equals
- Specified by:
equalsin interfaceXGettingCollection<E>- Parameters:
samples- is the collection which is checked for equalityequalator- is used to check the equality of the collections- Returns:
trueif the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)yieldstrue
-
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>- Parameters:
samples- is the collection which is checked for equalityequalator- the equalator to use to determine the equality of each element- Returns:
trueif this list is equal to the passed list,falseotherwise
-
intersect
public <C extends Consumer<? super E>> C intersect(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)Description copied from interface:XGettingCollectionTests equality between each element of the two lists and callsConsumer.accept(Object)on the targetConsumerfor the equal elements.
Therefore it effectively creates a mathematical intersection between the two collections.Since all MicroStream Collections implement the
Consumerinterface, new collections can be used as target.Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3);
BulkList<Integer> collection2 = BulkList.New(2,3,4);
BulkList<Integer> intersection = collection1.intersect(collection2, Equalator.identity(), BulkList.New());
Results inintersectioncontaining 2 and 3.- Specified by:
intersectin interfaceXGettingCollection<E>- Parameters:
samples- collection to intersect with.equalator- which is used for the equal-tests.target- on which theConsumer.accept(Object)is called for equal elements.- Returns:
- Given target
-
except
public <C extends Consumer<? super E>> C except(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)Description copied from interface:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor each element of this collection that is not contained in the other collection (through the given equalator).Since all MicroStream Collections implement the
Consumerinterface, new collections can be used as target.Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3);
BulkList<Integer> collection2 = BulkList.New(2,3,4);
BulkList<Integer> exceptCollection = collection1.except(collection2, Equalator.identity(), BulkList.New());
Results inexceptCollectioncontaining 1.- Specified by:
exceptin interfaceXGettingCollection<E>- Type Parameters:
C- type of the target- Parameters:
samples- collection whose elements are excluded from the target.equalator- which is used for the equal-tests.target- on which theConsumer.accept(Object)is called for elements not contained in the other collection.- Returns:
- Given target
-
union
public <C extends Consumer<? super E>> C union(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)Description copied from interface:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor all the elements of this collection. And calls it for all elements of the other collection, that are not already in this collection (defined by the givenEqualator)
Therefore it effectively creates a mathematical union between the two collections.Since all MicroStream Collections implement the
Consumerinterface, new collections can be used as target.Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3);
BulkList<Integer> collection2 = BulkList.New(2,3,4);
BulkList<Integer> union = collection1.union(collection2, Equalator.identity(), BulkList.New());
Results inunioncontaining 1, 2, 3 and 4.- Specified by:
unionin interfaceXGettingCollection<E>- Parameters:
samples- collection to build a union with.equalator- which is used for the equal-tests.target- on which theConsumer.accept(Object)is called for all unified elements.- Returns:
- Given target
-
copyTo
Description copied from interface:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor all the elements of this collection.Since all MicroStream Collections implement the
Consumerinterface, new collections can be used as target.Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3);
BulkList<Integer> copiedCollection = collection1.copyTo(BulkList.New());
Results incopiedCollectioncontaining 1, 2 and 3.- Specified by:
copyToin interfaceXGettingCollection<E>- Parameters:
target- on which theConsumer.accept(Object)is called for all elements of this collection.- Returns:
- Given target
-
filterTo
Description copied from interface:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor all the elements of this collection which testtrueon the given predicate.Since all MicroStream Collections implement the
Consumerinterface, new collections can be used as target.Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3);
BulkList<Integer> filteredCollection = collection1.filterTo(BulkList.New(), e-> e % 2 == 0);
Results infilteredCollectioncontaining 2.- Specified by:
filterToin interfaceXGettingCollection<E>- Parameters:
target- on which theConsumer.accept(Object)is called for elements that testtrue.predicate- on which to test all elements.- Returns:
- Given target
-
rngCopyTo
public <T> T[] rngCopyTo(int startIndex, int length, T[] target, int offset) -
distinct
Description copied from interface:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor all the unique/distinct elements of this collection. This means the elements are not equal to each other.
Uniqueness is defined by the collections internalEqualator.Since all MicroStream Collections implement the
Consumerinterface, new collections can be used as target.Example:
BulkList<Integer> collection1 = BulkList.New(1,2,2,3);
BulkList<Integer> distinctCollection = collection1.distinct(BulkList.New());
Results indistinctCollectioncontaining 1, 2 and 3.- Specified by:
distinctin interfaceXGettingCollection<E>- Parameters:
target- on which theConsumer.accept(Object)is called for every distinct element of this collection.- Returns:
- Given target
-
distinct
Description copied from interface:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor all the unique/distinct elements of this collection. This means the elements are not equal to each other.
Uniqueness is defined by the givenEqualator.Since all MicroStream Collections implement the
Consumerinterface, new collections can be used as target.Example:
BulkList<Integer> collection1 = BulkList.New(1,2,2,3);
BulkList<Integer> distinctCollection = collection1.distinct(BulkList.New(), Equalator.identity());
Results indistinctCollectioncontaining 1, 2 and 3.- Specified by:
distinctin interfaceXGettingCollection<E>- Parameters:
target- on which theConsumer.accept(Object)is called for every distinct element of this collection.equalator- defines what distinct means (which elements are equal to one another)- Returns:
- Given target
-
copySelection
Description copied from interface:XGettingSequenceIterates through all the elements of the given indices and calls theConsumer.accept(Object)on the targetConsumer.- Specified by:
copySelectionin interfaceXGettingSequence<E>- Type Parameters:
C- type of the target- Parameters:
target- on which theConsumer.accept(Object)is calledindices- of the elements which are copied- Returns:
- Given target
-
view
Description copied from interface:XGettingCollectionCreates a view of this collection and returns it. It is a read-only collection, which wraps around this collection and only allows read methods.A view is different from immutable collection (
XGettingCollection.immure()) in the way, that changes in this collection are still affecting the view. The immutable collection on the other hand has no reference to this collection and changes therefore do not affect the immutable collection.- 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>- Returns:
- new read-only collection to view this collection
-
view
Description copied from interface:XGettingSequenceCreates a sub-view of this collection and returns it. It is a read-only collection, which wraps around this collection and only allows read methods.
The view is limited to a range from the lowIndex to the highIndex.A view is different from immutable collection (
XGettingCollection.immure()) in the way, that changes in this collection are still affecting the view. The immutable collection on the other hand has no reference to this collection and changes therefore do not affect the immutable collection.- Specified by:
viewin interfaceXGettingList<E>- Specified by:
viewin interfaceXGettingSequence<E>- Specified by:
viewin interfaceXProcessingSequence<E>- Parameters:
fromIndex- defines lower boundary for the view of the collection.toIndex- defines higher boundary for the view of the collection.- Returns:
- new read-only collection to view a range of elements in this collection
-
shiftTo
Description copied from interface:XOrderingSequenceMoves the element from the sourceIndex in the sequence to the targetIndex.
All other elements are possibly moved to create the empty slot for the shifting element.Does not expand or shrink the capacity of the sequence.
Throws a
IndexExceededExceptionif sourceIndex or targetIndex are greater than the size of the sequence.- Specified by:
shiftToin interfaceXList<E>- Specified by:
shiftToin interfaceXOrderingSequence<E>- Specified by:
shiftToin interfaceXSortableSequence<E>- Parameters:
sourceIndex- points to the source element; Index of the source elementtargetIndex- points to the target element; Index of the target element- Returns:
- this
-
shiftTo
Description copied from interface:XOrderingSequenceMoves multiple elements from the sourceIndex in the sequence to the targetIndex.
All other elements are possibly moved to create the empty slot for the shifting element.Does not expand or shrink the capacity of the sequence.
Throws a
IndexExceededExceptionif sourceIndex or targetIndex exceed the size of the sequence.- Specified by:
shiftToin interfaceXList<E>- Specified by:
shiftToin interfaceXOrderingSequence<E>- Specified by:
shiftToin interfaceXSortableSequence<E>- Parameters:
sourceIndex- points to the source element; Index of the source elementtargetIndex- points to the target element; Index of the target elementlength- Amount of moved elements.- Returns:
- self
-
shiftBy
Description copied from interface:XOrderingSequenceMoves the element from the sourceIndex in the sequence to a higher index position.
All other elements are possibly moved to create the empty slot for the shifting element. ("to the right")Does not expand or shrink the capacity of the sequence.
Throws a
IndexExceededExceptionif sourceIndex or targetIndex (sourceIndex+distance) exceed the size of the sequence.- Specified by:
shiftByin interfaceXList<E>- Specified by:
shiftByin interfaceXOrderingSequence<E>- Specified by:
shiftByin interfaceXSortableSequence<E>- Parameters:
sourceIndex- points to the source element; Index of the source elementdistance- of how far the element should be moved. Example: 1 moves the element from position 21 to position 22- Returns:
- self
-
shiftBy
Description copied from interface:XOrderingSequenceMoves multiple elements from the sourceIndex in the sequence to a higher index position.
All other elements are possibly moved to create the empty slot for the shifting elements. ("to the right")Does not expand or shrink the capacity of the sequence.
Throws a
IndexExceededExceptionif sourceIndex or targetIndex (sourceIndex+distance+length) exceed the size of the sequence.- Specified by:
shiftByin interfaceXList<E>- Specified by:
shiftByin interfaceXOrderingSequence<E>- Specified by:
shiftByin interfaceXSortableSequence<E>- Parameters:
sourceIndex- points to the source element; Index of the source elementdistance- of how far the element should be moved. Example: 1 moves the element from position 21 to position 22length- Amount of moved elements.- Returns:
- self
-
swap
public ArrayCollector<E> swap(long indexA, long indexB) throws IndexOutOfBoundsException, ArrayIndexOutOfBoundsException- Specified by:
swapin interfaceXDecreasingList<E>- Specified by:
swapin interfaceXDecreasingSequence<E>- Specified by:
swapin interfaceXIncreasingList<E>- Specified by:
swapin interfaceXIncreasingSequence<E>- Specified by:
swapin interfaceXList<E>- Specified by:
swapin interfaceXOrderingSequence<E>- Specified by:
swapin interfaceXSettingList<E>- Specified by:
swapin interfaceXSettingSequence<E>- Specified by:
swapin interfaceXSortableSequence<E>- Throws:
IndexOutOfBoundsExceptionArrayIndexOutOfBoundsException
-
swap
- Specified by:
swapin interfaceXDecreasingList<E>- Specified by:
swapin interfaceXDecreasingSequence<E>- Specified by:
swapin interfaceXIncreasingList<E>- Specified by:
swapin interfaceXIncreasingSequence<E>- Specified by:
swapin interfaceXList<E>- Specified by:
swapin interfaceXOrderingSequence<E>- Specified by:
swapin interfaceXSettingList<E>- Specified by:
swapin interfaceXSettingSequence<E>- Specified by:
swapin interfaceXSortableSequence<E>
-
reverse
Description copied from interface:XSortableSequenceReverses the order of its own elements and returns itself.Unlike the
XSortableSequence.toReversed()method, this method does not create a new collection, but changes the order of its own elements.- Specified by:
reversein interfaceXDecreasingList<E>- Specified by:
reversein interfaceXDecreasingSequence<E>- Specified by:
reversein interfaceXIncreasingList<E>- Specified by:
reversein interfaceXIncreasingSequence<E>- Specified by:
reversein interfaceXList<E>- Specified by:
reversein interfaceXOrderingSequence<E>- Specified by:
reversein interfaceXSettingList<E>- Specified by:
reversein interfaceXSettingSequence<E>- Specified by:
reversein interfaceXSortableSequence<E>- Returns:
- this
-
setFirst
- Specified by:
setFirstin interfaceXSettingSequence<E>
-
setLast
- Specified by:
setLastin interfaceXSettingSequence<E>
-
setAll
- Specified by:
setAllin interfaceXDecreasingList<E>- Specified by:
setAllin interfaceXDecreasingSequence<E>- Specified by:
setAllin interfaceXIncreasingList<E>- Specified by:
setAllin interfaceXList<E>- Specified by:
setAllin interfaceXSettingList<E>- Specified by:
setAllin interfaceXSettingSequence<E>
-
set
- Specified by:
setin interfaceXDecreasingList<E>- Specified by:
setin interfaceXDecreasingSequence<E>- Specified by:
setin interfaceXIncreasingList<E>- Specified by:
setin interfaceXList<E>- Specified by:
setin interfaceXSettingList<E>- Specified by:
setin interfaceXSettingSequence<E>
-
set
public ArrayCollector<E> set(long offset, XGettingSequence<? extends E> elements, long elementsOffset, long elementsLength)- Specified by:
setin interfaceXDecreasingList<E>- Specified by:
setin interfaceXDecreasingSequence<E>- Specified by:
setin interfaceXIncreasingList<E>- Specified by:
setin interfaceXList<E>- Specified by:
setin interfaceXSettingList<E>- Specified by:
setin interfaceXSettingSequence<E>
-
fill
Description copied from interface:XSettingListFills all slots from the offset to the offset+length with the given element, regardless of whether or not a slot isnull.- Specified by:
fillin interfaceXDecreasingList<E>- Specified by:
fillin interfaceXIncreasingList<E>- Specified by:
fillin interfaceXList<E>- Specified by:
fillin interfaceXSettingList<E>- Parameters:
offset- from the start of the collection (start index)length- of how many slots should be filledelement- to use for filling of slots- Returns:
- this
-
sort
Description copied from interface:SortableSorts this collection according to the given comparator and returns itself.- Specified by:
sortin interfaceSortable<E>- Specified by:
sortin interfaceXDecreasingList<E>- Specified by:
sortin interfaceXDecreasingSequence<E>- Specified by:
sortin interfaceXIncreasingList<E>- Specified by:
sortin interfaceXIncreasingSequence<E>- Specified by:
sortin interfaceXList<E>- Specified by:
sortin interfaceXSequence<E>- Specified by:
sortin interfaceXSettingList<E>- Specified by:
sortin interfaceXSettingSequence<E>- Specified by:
sortin interfaceXSortableSequence<E>- Parameters:
comparator- to sort this collection- Returns:
- this
-
replaceOne
Description copied from interface:XReplacingBagReplaces the first element that is equal to the given element with the replacement and then returns true.- Specified by:
replaceOnein interfaceXReplacingBag<E>- Parameters:
element- to replacereplacement- for the found element- Returns:
trueif element is found,falseif not
-
replaceOne
- Specified by:
replaceOnein interfaceXReplacingBag<E>
-
replace
- Specified by:
replacein interfaceXReplacingBag<E>
-
replace
- Specified by:
replacein interfaceXReplacingBag<E>
-
replaceAll
- Specified by:
replaceAllin interfaceXReplacingBag<E>
-
substitute
- Specified by:
substitutein interfaceXReplacingCollection<E>
-
substitute
- Specified by:
substitutein interfaceXReplacingBag<E>
-
currentCapacity
public long currentCapacity()Description copied from interface:CapacityExtendableReturns the current amount of elements this instance can hold before a storage rebuild becomes necessary.For carrier implementations that don't have a concept of storage rebuilding (like linked list for example) this method returns the same value as
CapacityCarrying.maximumCapacity().- Specified by:
currentCapacityin interfaceCapacityExtendable- Returns:
- the current capacity of this instance before a rebuild is required.
-
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
-
optimize
public long optimize()Description copied from interface:OptimizableCollectionOptimizes the internal storage of this collection and returns the storage size of the collection after the process is complete.- Specified by:
optimizein interfaceOptimizableCollection- Specified by:
optimizein interfaceXRemovingCollection<E>- Returns:
- the storage size of the collection after the optimzation.
-
ensureFreeCapacity
Description copied from interface:CapacityExtendableEnsures that the next minimalFreeCapacity elements can be actually added in a fast way, meaning for example no internal storage rebuild will be necessary.- Specified by:
ensureFreeCapacityin interfaceCapacityExtendable
-
ensureCapacity
- Specified by:
ensureCapacityin interfaceCapacityExtendable
-
accept
-
add
Description copied from interface:XAddingCollectionAdds the passed element.- Specified by:
addin interfaceXAddingCollection<E>- Parameters:
element- to add- Returns:
trueif element was added;falseif not
-
addAll
- Specified by:
addAllin interfaceXAddGetCollection<E>- Specified by:
addAllin interfaceXAddingBag<E>- Specified by:
addAllin interfaceXAddingCollection<E>- Specified by:
addAllin interfaceXAddingList<E>- Specified by:
addAllin interfaceXAddingSequence<E>- Specified by:
addAllin interfaceXBag<E>- Specified by:
addAllin interfaceXBasicList<E>- Specified by:
addAllin interfaceXBasicSequence<E>- Specified by:
addAllin interfaceXCollection<E>- Specified by:
addAllin interfaceXExpandingList<E>- Specified by:
addAllin interfaceXExpandingSequence<E>- Specified by:
addAllin interfaceXExtendingList<E>- Specified by:
addAllin interfaceXExtendingSequence<E>- Specified by:
addAllin interfaceXIncreasingList<E>- Specified by:
addAllin interfaceXIncreasingSequence<E>- Specified by:
addAllin interfaceXInputtingList<E>- Specified by:
addAllin interfaceXInputtingSequence<E>- Specified by:
addAllin interfaceXInsertingSequence<E>- Specified by:
addAllin interfaceXList<E>- Specified by:
addAllin interfaceXPutGetCollection<E>- Specified by:
addAllin interfaceXPutGetList<E>- Specified by:
addAllin interfaceXPutGetSequence<E>- Specified by:
addAllin interfaceXPuttingBag<E>- Specified by:
addAllin interfaceXPuttingList<E>- Specified by:
addAllin interfaceXSequence<E>
-
addAll
- Specified by:
addAllin interfaceXAddGetCollection<E>- Specified by:
addAllin interfaceXAddingBag<E>- Specified by:
addAllin interfaceXAddingCollection<E>- Specified by:
addAllin interfaceXAddingList<E>- Specified by:
addAllin interfaceXAddingSequence<E>- Specified by:
addAllin interfaceXBag<E>- Specified by:
addAllin interfaceXBasicList<E>- Specified by:
addAllin interfaceXBasicSequence<E>- Specified by:
addAllin interfaceXCollection<E>- Specified by:
addAllin interfaceXExpandingList<E>- Specified by:
addAllin interfaceXExpandingSequence<E>- Specified by:
addAllin interfaceXExtendingList<E>- Specified by:
addAllin interfaceXExtendingSequence<E>- Specified by:
addAllin interfaceXIncreasingList<E>- Specified by:
addAllin interfaceXIncreasingSequence<E>- Specified by:
addAllin interfaceXInputtingList<E>- Specified by:
addAllin interfaceXInputtingSequence<E>- Specified by:
addAllin interfaceXInsertingSequence<E>- Specified by:
addAllin interfaceXList<E>- Specified by:
addAllin interfaceXPutGetCollection<E>- Specified by:
addAllin interfaceXPutGetList<E>- Specified by:
addAllin interfaceXPutGetSequence<E>- Specified by:
addAllin interfaceXPuttingBag<E>- Specified by:
addAllin interfaceXPuttingList<E>- Specified by:
addAllin interfaceXSequence<E>
-
addAll
- Specified by:
addAllin interfaceXAddGetCollection<E>- Specified by:
addAllin interfaceXAddingBag<E>- Specified by:
addAllin interfaceXAddingCollection<E>- Specified by:
addAllin interfaceXAddingList<E>- Specified by:
addAllin interfaceXAddingSequence<E>- Specified by:
addAllin interfaceXBag<E>- Specified by:
addAllin interfaceXBasicList<E>- Specified by:
addAllin interfaceXBasicSequence<E>- Specified by:
addAllin interfaceXCollection<E>- Specified by:
addAllin interfaceXExpandingList<E>- Specified by:
addAllin interfaceXExpandingSequence<E>- Specified by:
addAllin interfaceXExtendingList<E>- Specified by:
addAllin interfaceXExtendingSequence<E>- Specified by:
addAllin interfaceXIncreasingList<E>- Specified by:
addAllin interfaceXIncreasingSequence<E>- Specified by:
addAllin interfaceXInputtingList<E>- Specified by:
addAllin interfaceXInputtingSequence<E>- Specified by:
addAllin interfaceXInsertingSequence<E>- Specified by:
addAllin interfaceXList<E>- Specified by:
addAllin interfaceXPutGetCollection<E>- Specified by:
addAllin interfaceXPutGetList<E>- Specified by:
addAllin interfaceXPutGetSequence<E>- Specified by:
addAllin interfaceXPuttingBag<E>- Specified by:
addAllin interfaceXPuttingList<E>- Specified by:
addAllin interfaceXSequence<E>
-
nullAdd
public boolean nullAdd()- Specified by:
nullAddin interfaceXAddingCollection<E>
-
put
Description copied from interface:XPuttingCollectionAdds the specified element to this collection if it is not already present (optional operation).- Specified by:
putin interfaceXPuttingCollection<E>- Parameters:
element- to add- Returns:
- true if this collection did not already contain the specified element
-
putAll
Description copied from interface:XPuttingBagAdds the specified elements to this collection if it is not already present (optional operation).In this implementation it is identical to
XPuttingBag.addAll(Object...)- Specified by:
putAllin interfaceXBag<E>- Specified by:
putAllin interfaceXBasicList<E>- Specified by:
putAllin interfaceXBasicSequence<E>- Specified by:
putAllin interfaceXCollection<E>- Specified by:
putAllin interfaceXExpandingList<E>- Specified by:
putAllin interfaceXExpandingSequence<E>- Specified by:
putAllin interfaceXIncreasingList<E>- Specified by:
putAllin interfaceXIncreasingSequence<E>- Specified by:
putAllin interfaceXInputtingList<E>- Specified by:
putAllin interfaceXInputtingSequence<E>- Specified by:
putAllin interfaceXList<E>- Specified by:
putAllin interfaceXPutGetCollection<E>- Specified by:
putAllin interfaceXPutGetList<E>- Specified by:
putAllin interfaceXPutGetSequence<E>- Specified by:
putAllin interfaceXPuttingBag<E>- Specified by:
putAllin interfaceXPuttingCollection<E>- Specified by:
putAllin interfaceXPuttingList<E>- Specified by:
putAllin interfaceXPuttingSequence<E>- Specified by:
putAllin interfaceXSequence<E>- Parameters:
elements- to add- Returns:
- this
-
putAll
Description copied from interface:XPuttingBagAdds the specified elements to this collection if it is not already present (optional operation).
Only the elements with indizes from the srcStartIndex to the srcStartIndex+srcLength are put in the collection.In this implementation it is identical to
XPuttingBag.addAll(Object[], int, int)- Specified by:
putAllin interfaceXBag<E>- Specified by:
putAllin interfaceXBasicList<E>- Specified by:
putAllin interfaceXBasicSequence<E>- Specified by:
putAllin interfaceXCollection<E>- Specified by:
putAllin interfaceXExpandingList<E>- Specified by:
putAllin interfaceXExpandingSequence<E>- Specified by:
putAllin interfaceXIncreasingList<E>- Specified by:
putAllin interfaceXIncreasingSequence<E>- Specified by:
putAllin interfaceXInputtingList<E>- Specified by:
putAllin interfaceXInputtingSequence<E>- Specified by:
putAllin interfaceXList<E>- Specified by:
putAllin interfaceXPutGetCollection<E>- Specified by:
putAllin interfaceXPutGetList<E>- Specified by:
putAllin interfaceXPutGetSequence<E>- Specified by:
putAllin interfaceXPuttingBag<E>- Specified by:
putAllin interfaceXPuttingCollection<E>- Specified by:
putAllin interfaceXPuttingList<E>- Specified by:
putAllin interfaceXPuttingSequence<E>- Specified by:
putAllin interfaceXSequence<E>- Parameters:
elements- to addoffset- start index of elements-array to add to collectionlength- length of elements-array to add to collection- Returns:
- this
-
putAll
Description copied from interface:XPuttingBagAdds the specified elements to this collection if it is not already present (optional operation).In this implementation it is identical to
XPuttingBag.addAll(XGettingCollection)- Specified by:
putAllin interfaceXBag<E>- Specified by:
putAllin interfaceXBasicList<E>- Specified by:
putAllin interfaceXBasicSequence<E>- Specified by:
putAllin interfaceXCollection<E>- Specified by:
putAllin interfaceXExpandingList<E>- Specified by:
putAllin interfaceXExpandingSequence<E>- Specified by:
putAllin interfaceXIncreasingList<E>- Specified by:
putAllin interfaceXIncreasingSequence<E>- Specified by:
putAllin interfaceXInputtingList<E>- Specified by:
putAllin interfaceXInputtingSequence<E>- Specified by:
putAllin interfaceXList<E>- Specified by:
putAllin interfaceXPutGetCollection<E>- Specified by:
putAllin interfaceXPutGetList<E>- Specified by:
putAllin interfaceXPutGetSequence<E>- Specified by:
putAllin interfaceXPuttingBag<E>- Specified by:
putAllin interfaceXPuttingCollection<E>- Specified by:
putAllin interfaceXPuttingList<E>- Specified by:
putAllin interfaceXPuttingSequence<E>- Specified by:
putAllin interfaceXSequence<E>- Parameters:
elements- to add- Returns:
- this
-
nullPut
public boolean nullPut()- Specified by:
nullPutin interfaceXPuttingCollection<E>
-
prepend
- Specified by:
prependin interfaceXPrependingSequence<E>
-
prependAll
- Specified by:
prependAllin interfaceXExpandingList<E>- Specified by:
prependAllin interfaceXExpandingSequence<E>- Specified by:
prependAllin interfaceXExtendingList<E>- Specified by:
prependAllin interfaceXExtendingSequence<E>- Specified by:
prependAllin interfaceXIncreasingList<E>- Specified by:
prependAllin interfaceXIncreasingSequence<E>- Specified by:
prependAllin interfaceXInputtingList<E>- Specified by:
prependAllin interfaceXInputtingSequence<E>- Specified by:
prependAllin interfaceXInsertingSequence<E>- Specified by:
prependAllin interfaceXList<E>- Specified by:
prependAllin interfaceXPrependingList<E>- Specified by:
prependAllin interfaceXPrependingSequence<E>- Specified by:
prependAllin interfaceXPreputtingList<E>- Specified by:
prependAllin interfaceXPreputtingSequence<E>
-
prependAll
- Specified by:
prependAllin interfaceXExpandingList<E>- Specified by:
prependAllin interfaceXExpandingSequence<E>- Specified by:
prependAllin interfaceXExtendingList<E>- Specified by:
prependAllin interfaceXExtendingSequence<E>- Specified by:
prependAllin interfaceXIncreasingList<E>- Specified by:
prependAllin interfaceXIncreasingSequence<E>- Specified by:
prependAllin interfaceXInputtingList<E>- Specified by:
prependAllin interfaceXInputtingSequence<E>- Specified by:
prependAllin interfaceXInsertingSequence<E>- Specified by:
prependAllin interfaceXList<E>- Specified by:
prependAllin interfaceXPrependingList<E>- Specified by:
prependAllin interfaceXPrependingSequence<E>- Specified by:
prependAllin interfaceXPreputtingList<E>- Specified by:
prependAllin interfaceXPreputtingSequence<E>
-
prependAll
- Specified by:
prependAllin interfaceXExpandingList<E>- Specified by:
prependAllin interfaceXExpandingSequence<E>- Specified by:
prependAllin interfaceXExtendingList<E>- Specified by:
prependAllin interfaceXExtendingSequence<E>- Specified by:
prependAllin interfaceXIncreasingList<E>- Specified by:
prependAllin interfaceXIncreasingSequence<E>- Specified by:
prependAllin interfaceXInputtingList<E>- Specified by:
prependAllin interfaceXInputtingSequence<E>- Specified by:
prependAllin interfaceXInsertingSequence<E>- Specified by:
prependAllin interfaceXList<E>- Specified by:
prependAllin interfaceXPrependingList<E>- Specified by:
prependAllin interfaceXPrependingSequence<E>- Specified by:
prependAllin interfaceXPreputtingList<E>- Specified by:
prependAllin interfaceXPreputtingSequence<E>
-
nullPrepend
public boolean nullPrepend()- Specified by:
nullPrependin interfaceXPrependingSequence<E>
-
preput
- Specified by:
preputin interfaceXPreputtingSequence<E>
-
preputAll
- Specified by:
preputAllin interfaceXExpandingList<E>- Specified by:
preputAllin interfaceXExpandingSequence<E>- Specified by:
preputAllin interfaceXIncreasingList<E>- Specified by:
preputAllin interfaceXIncreasingSequence<E>- Specified by:
preputAllin interfaceXInputtingList<E>- Specified by:
preputAllin interfaceXInputtingSequence<E>- Specified by:
preputAllin interfaceXList<E>- Specified by:
preputAllin interfaceXPreputtingList<E>- Specified by:
preputAllin interfaceXPreputtingSequence<E>
-
preputAll
- Specified by:
preputAllin interfaceXExpandingList<E>- Specified by:
preputAllin interfaceXExpandingSequence<E>- Specified by:
preputAllin interfaceXIncreasingList<E>- Specified by:
preputAllin interfaceXIncreasingSequence<E>- Specified by:
preputAllin interfaceXInputtingList<E>- Specified by:
preputAllin interfaceXInputtingSequence<E>- Specified by:
preputAllin interfaceXList<E>- Specified by:
preputAllin interfaceXPreputtingList<E>- Specified by:
preputAllin interfaceXPreputtingSequence<E>
-
preputAll
- Specified by:
preputAllin interfaceXExpandingList<E>- Specified by:
preputAllin interfaceXExpandingSequence<E>- Specified by:
preputAllin interfaceXIncreasingList<E>- Specified by:
preputAllin interfaceXIncreasingSequence<E>- Specified by:
preputAllin interfaceXInputtingList<E>- Specified by:
preputAllin interfaceXInputtingSequence<E>- Specified by:
preputAllin interfaceXList<E>- Specified by:
preputAllin interfaceXPreputtingList<E>- Specified by:
preputAllin interfaceXPreputtingSequence<E>
-
nullPreput
public boolean nullPreput()- Specified by:
nullPreputin interfaceXPreputtingSequence<E>
-
insert
- Specified by:
insertin interfaceXInsertingSequence<E>
-
insertAll
@SafeVarargs public final long insertAll(long index, E... elements) throws IndexOutOfBoundsException- Specified by:
insertAllin interfaceXInsertingSequence<E>- Throws:
IndexOutOfBoundsException
-
insertAll
- Specified by:
insertAllin interfaceXInsertingSequence<E>
-
insertAll
- Specified by:
insertAllin interfaceXInsertingSequence<E>
-
nullInsert
public boolean nullInsert(long index)- Specified by:
nullInsertin interfaceXInsertingSequence<E>
-
input
- Specified by:
inputin interfaceXInputtingSequence<E>
-
inputAll
@SafeVarargs public final long inputAll(long index, E... elements) throws IndexOutOfBoundsException- Specified by:
inputAllin interfaceXInputtingSequence<E>- Throws:
IndexOutOfBoundsException
-
inputAll
- Specified by:
inputAllin interfaceXInputtingSequence<E>
-
inputAll
- Specified by:
inputAllin interfaceXInputtingSequence<E>
-
nullInput
public boolean nullInput(long index)- Specified by:
nullInputin interfaceXInputtingSequence<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>
-
consolidate
public long consolidate()Description copied from interface:ConsolidatableCollectionConsolidates 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).- Specified by:
consolidatein interfaceConsolidatableCollection- Specified by:
consolidatein interfaceXRemovingCollection<E>- Returns:
- the number of discarded entries.
-
retrieve
- Specified by:
retrievein interfaceXProcessingCollection<E>
-
retrieveBy
- Specified by:
retrieveByin interfaceXProcessingCollection<E>
-
removeOne
- Specified by:
removeOnein interfaceXRemovingCollection<E>
-
remove
- Specified by:
removein interfaceXRemovingCollection<E>
-
nullRemove
public long nullRemove()- Specified by:
nullRemovein interfaceXRemovingCollection<E>
-
removeBy
- Specified by:
removeByin interfaceXProcessingCollection<E>
-
retainAll
Description copied from interface:XRemovingCollectionRemoving all elements except the ones contained in the given elements-collection.Basically intersect this collection with the given collection and only keeping the resulting elements.
- Specified by:
retainAllin interfaceXRemovingCollection<E>- Parameters:
elements- to retain- Returns:
- Amount of deleted elements
-
process
- Specified by:
processin interfaceProcessable<E>
-
moveTo
- Specified by:
moveToin interfaceXProcessingCollection<E>
-
moveSelection
- Specified by:
moveSelectionin interfaceXProcessingSequence<E>
-
removeAll
- Specified by:
removeAllin interfaceXRemovingCollection<E>
-
removeDuplicates
- Specified by:
removeDuplicatesin interfaceXProcessingCollection<E>
-
removeDuplicates
public long removeDuplicates()- Specified by:
removeDuplicatesin interfaceXRemovingCollection<E>
-
fetch
- Specified by:
fetchin interfaceXProcessingCollection<E>
-
pop
- Specified by:
popin interfaceXProcessingSequence<E>
-
pinch
- Specified by:
pinchin interfaceXProcessingCollection<E>
-
pick
- Specified by:
pickin interfaceXProcessingSequence<E>
-
removeSelection
public long removeSelection(long[] indices)- Specified by:
removeSelectionin interfaceXRemovingSequence<E>
-
removeRange
- Specified by:
removeRangein interfaceXRemovingSequence<E>
-
retainRange
Description copied from interface:XRemovingSequenceRemoving all elements but the ones from the offset (basically start index) to the offset+length (end index).- Specified by:
retainRangein interfaceXList<E>- Specified by:
retainRangein interfaceXRemovingSequence<E>- Parameters:
startIndex- is the index of the first element to retainlength- is the amount of elements to retain- Returns:
- this
-
isEmpty
public boolean isEmpty() -
iterator
-
listIterator
- Specified by:
listIteratorin interfaceXGettingList<E>
-
listIterator
- Specified by:
listIteratorin interfaceXGettingList<E>
-
set
public boolean set(long index, E element) throws IndexOutOfBoundsException, ArrayIndexOutOfBoundsException- Specified by:
setin interfaceXSettingSequence<E>- Throws:
IndexOutOfBoundsExceptionArrayIndexOutOfBoundsException
-
setGet
public E setGet(long index, E element) throws IndexOutOfBoundsException, ArrayIndexOutOfBoundsException- Specified by:
setGetin interfaceXSettingSequence<E>- Throws:
IndexOutOfBoundsExceptionArrayIndexOutOfBoundsException
-
size
public long size()- Specified by:
sizein interfaceSized- Specified by:
sizein interfaceXGettingCollection<E>
-
range
- Specified by:
rangein interfaceXDecreasingList<E>- Specified by:
rangein interfaceXDecreasingSequence<E>- Specified by:
rangein interfaceXGettingList<E>- Specified by:
rangein interfaceXGettingSequence<E>- Specified by:
rangein interfaceXIncreasingList<E>- Specified by:
rangein interfaceXIncreasingSequence<E>- Specified by:
rangein interfaceXList<E>- Specified by:
rangein interfaceXSettingList<E>- Specified by:
rangein interfaceXSettingSequence<E>
-
toString
-
toArray
Description copied from interface:XGettingCollectionReturns an array containing all of the elements in this collection.The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.
This method acts as bridge between MicroStream-based collections and Java-native-based APIs.
- Specified by:
toArrayin interfaceXGettingCollection<E>- Returns:
- an array containing all of the elements in this collection
-
at
- Specified by:
atin interfaceXGettingSequence<E>- Throws:
ArrayIndexOutOfBoundsException
-
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>
-
removeAt
- Specified by:
removeAtin interfaceXProcessingSequence<E>- Throws:
IndexOutOfBoundsExceptionArrayIndexOutOfBoundsException
-
equals
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
-
hashCode
Deprecated.- Specified by:
hashCodein interfaceXGettingCollection<E>- Overrides:
hashCodein classObject
-
old
- Specified by:
oldin interfaceXGettingCollection<E>- Specified by:
oldin interfaceXGettingList<E>
-