Class BulkList<E>
- Type Parameters:
E
- type of contained elements
- 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>
,IdentityEqualityLogic
,Processable<E>
,Clearable
,Composition
,Copyable
public final class BulkList<E> extends AbstractSimpleArrayCollection<E> implements XList<E>, Composition, IdentityEqualityLogic
List
.
Full scale general purpose implementation of extended collection type XList
.
In contrast to EqBulkList
this implementation uses the default isSame-Equalator(Equalator.identity()
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 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.
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.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BulkList.Creator<E>
static class
BulkList.OldBulkList<E>
static class
BulkList.Supplier<K,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.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 BulkList()
Default constructor instantiating an empty instance with default (minimum) capacity.BulkList(int initialCapacity)
Initial capacity constructor instantiating an empty instance with a given initial capacity.BulkList(int initialCapacity, E[] src, int srcStart, int srcLength)
Detailed initializing constructor allowing to specify initial capacity and a custom array range of initial data.BulkList(E initialElement)
Default constructor instantiating an instance with default (minimum) capacity and the given element already included.BulkList(E... elements)
Convenience initial data constructor, instantiating a new instance containing all elements of the passed array.BulkList(BulkList<? extends E> original)
Copy constructor that instantiates a new instance with a copy of the passed original instance's data and same size. -
Method Summary
Modifier and Type Method Description void
accept(E element)
boolean
add(E element)
Adds the passed element.BulkList<E>
addAll(E... elements)
BulkList<E>
addAll(E[] elements, int offset, int length)
BulkList<E>
addAll(XGettingCollection<? extends E> elements)
boolean
applies(Predicate<? super E> predicate)
Tests each element of the collection on the given predicate.E
at(long index)
static <E> Aggregator<E,BulkList<E>>
Builder()
Creates anAggregator
that accepts elements and adds them to a newBulkList
.static <E> Aggregator<E,BulkList<E>>
Builder(long initialCapacity)
Creates aAggregator
that accepts elements and adds them to a newBulkList
with a specific initial capacity.void
clear()
Clears all elements from the collection while leaving the capacity as it is.Aggregator<E,BulkList<E>>
collector()
long
consolidate()
Consolidates the internal storage of this collection by discarding all elements of the internal storage that have become obsolete or otherwise unneeded anymore.boolean
contains(E element)
Checks if the given element is contained in the collection.boolean
containsAll(XGettingCollection<? extends E> elements)
boolean
containsId(E element)
Special version of contains() that guarantees to use identity comparison (" == ") when searching for the given element regardless of the collection's internal logic.
This method has the same behavior asXGettingCollection.containsSearched(Predicate)
with aPredicate
implementation that checks for object identity.boolean
containsSearched(Predicate<? super E> predicate)
BulkList<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 targetConsumer
for all the elements of this collection.long
count(E element)
Count how many times this element matches another element in the collection using theEqualator
.long
countBy(Predicate<? super E> predicate)
Count how many matches are found using the given predicate on each element of the collection.long
currentCapacity()
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 targetConsumer
for 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 targetConsumer
for all the unique/distinct elements of this collection.BulkList<E>
ensureCapacity(long minCapacity)
BulkList<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()
boolean
equals(Object o)
Deprecated.boolean
equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
boolean
equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
Returnstrue
if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.<C extends Consumer<? super E>>
Cexcept(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)
CallsConsumer.accept(Object)
on the targetConsumer
for each element of this collection that is not contained in the other collection (through the given equalator).E
fetch()
BulkList<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 targetConsumer
for all the elements of this collection which testtrue
on the given predicate.E
first()
Gets first element or throwsIndexOutOfBoundsException
if the collection is empty.E
get()
Gets the first element in the collection.int
hashCode()
Deprecated.boolean
hasVolatileElements()
Tells if this collection contains volatile elements.
An element is volatile, if it can become no longer reachable by the collection without being removed from the collection.ConstList<E>
immure()
Provides an instance of an immutable collection type with equal behavior and data as this instance.static <E> Function<BulkList<E>,ConstList<E>>
Immurer()
long
indexBy(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.long
indexOf(E element)
boolean
input(long index, E element)
long
inputAll(long index, E... elements)
long
inputAll(long index, E[] elements, int offset, int length)
long
inputAll(long index, XGettingCollection<? extends E> elements)
boolean
insert(long index, E element)
long
insertAll(long index, E... elements)
long
insertAll(long index, E[] elements, int offset, int length)
long
insertAll(long index, XGettingCollection<? extends E> elements)
protected int
internalCountingAddAll(E[] elements)
protected int
internalCountingAddAll(E[] elements, int offset, int length)
protected int
internalCountingAddAll(XGettingCollection<? extends E> elements)
protected int
internalCountingPutAll(E[] elements)
protected int
internalCountingPutAll(E[] elements, int offset, int length)
protected int
internalCountingPutAll(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 int
internalSize()
<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 targetConsumer
for the equal elements.
Therefore it effectively creates a mathematical intersection between the two collections.boolean
isEmpty()
boolean
isFull()
boolean
isSorted(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 theXIterable
until all elements have been processed or the action throws an exception.<P extends IndexedAcceptor<? super E>>
PiterateIndexed(P procedure)
Iterates over elements with theIndexedAcceptor
to use not only the element itself but also its coherent index.Iterator<E>
iterator()
<A> A
join(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.E
last()
Gets last element or throwsIndexOutOfBoundsException
if the collection is empty.long
lastIndexBy(Predicate<? super E> predicate)
Iterates backwards through the collection and returns the index of the last element that the passedPredicate
applies to immediately.
Stops iterating on the first element that the predicate applies to.long
lastIndexOf(E element)
ListIterator<E>
listIterator()
ListIterator<E>
listIterator(long index)
E
max(Comparator<? super E> comparator)
long
maximumCapacity()
Returns the maximum amount of elements this carrier instance can contain.
The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g.long
maxIndex(Comparator<? super E> comparator)
E
min(Comparator<? super E> comparator)
long
minIndex(Comparator<? super E> comparator)
<C extends Consumer<? super E>>
CmoveSelection(C target, long... indices)
<C extends Consumer<? super E>>
CmoveTo(C target, Predicate<? super E> predicate)
static <E> BulkList<E>
New()
Pseudo-constructor method to create a newBulkList
instance with default (minimum) capacity.static <E> BulkList<E>
New(long initialCapacity)
Pseudo-constructor method to create a newBulkList
instance with a given initial capacity.static <E> BulkList<E>
New(E... initialElements)
Pseudo-constructor method to create a newBulkList
instance containing all elements of the passed array.static <E> BulkList<E>
New(Iterable<? extends E> initialElements)
Pseudo-constructor method to create a newBulkList
instance and adds all the given elements to it.static <E> BulkList<E>
New(XGettingCollection<? extends E> initialElements)
Pseudo-constructor method to create a newBulkList
instance with the needed amount of capacity and adds all elements to it.static <E> BulkList<E>
New(XIterable<? extends E> initialElements)
Pseudo-constructor method to create a newBulkList
instance and adds all the given elements to it.static <E> BulkList<E>
NewFromSingle(E initialElement)
Pseudo-constructor method to create a newBulkList
instance with default (minimum) capacity and the given element already included.boolean
nullAdd()
boolean
nullAllowed()
Defines if null-elements are allowed inside the collection or not.boolean
nullContained()
boolean
nullInput(long index)
boolean
nullInsert(long index)
boolean
nullPrepend()
boolean
nullPreput()
boolean
nullPut()
long
nullRemove()
BulkList.OldBulkList<E>
old()
long
optimize()
Optimizes the internal storage of this collection and returns the storage size of the collection after the process is complete.E
peek()
Gets last element or null if the collection is empty.E
pick()
E
pinch()
E
poll()
Gets first element or null if the collection is empty.E
pop()
boolean
prepend(E element)
BulkList<E>
prependAll(E... elements)
BulkList<E>
prependAll(E[] elements, int offset, int length)
BulkList<E>
prependAll(XGettingCollection<? extends E> elements)
boolean
preput(E element)
BulkList<E>
preputAll(E... elements)
BulkList<E>
preputAll(E[] elements, int offset, int length)
BulkList<E>
preputAll(XGettingCollection<? extends E> elements)
<P extends Consumer<? super E>>
Pprocess(P procedure)
boolean
put(E element)
Adds the specified element to this collection if it is not already present (optional operation).BulkList<E>
putAll(E... elements)
Adds the specified elements to this collection if it is not already present (optional operation).BulkList<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.BulkList<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)
long
remove(E element)
long
removeAll(XGettingCollection<? extends E> elements)
E
removeAt(long index)
long
removeBy(Predicate<? super E> predicate)
long
removeDuplicates()
long
removeDuplicates(Equalator<? super E> equalator)
boolean
removeOne(E element)
BulkList<E>
removeRange(long startIndex, long length)
long
removeSelection(long[] indices)
long
replace(E element, E replacement)
long
replace(Predicate<? super E> predicate, E replacement)
long
replaceAll(XGettingCollection<? extends E> elements, E replacement)
boolean
replaceOne(E element, E replacement)
Replaces the first element that is equal to the given element with the replacement and then returns true.boolean
replaceOne(Predicate<? super E> predicate, E substitute)
long
retainAll(XGettingCollection<? extends E> elements)
Removing all elements except the ones contained in the given elements-collection.BulkList<E>
retainRange(long startIndex, long length)
Removing all elements but the ones from the offset (basically start index) to the offset+length (end index).E
retrieve(E element)
E
retrieveBy(Predicate<? super E> predicate)
BulkList<E>
reverse()
Reverses the order of its own elements and returns itself.long
scan(Predicate<? super E> predicate)
Iterates through the collection and returns the index of the last element that the passedPredicate
applied to ("scanning").E
search(Predicate<? super E> predicate)
Returns the first contained element matching the passed predicate.E
seek(E sample)
Returns the first contained element matching the passed sample as defined by the collection's equality logic or null, if no fitting element is contained.boolean
set(long index, E element)
BulkList<E>
set(long offset, E[] src, int srcIndex, int srcLength)
BulkList<E>
set(long offset, XGettingSequence<? extends E> elements, long elementsOffset, long elementsLength)
BulkList<E>
setAll(long offset, E... elements)
void
setFirst(E element)
E
setGet(long index, E element)
void
setLast(E element)
BulkList<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.BulkList<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.BulkList<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.BulkList<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.long
size()
BulkList<E>
sort(Comparator<? super E> comparator)
Sorts this collection according to the given comparator and returns itself.long
substitute(Function<? super E,? extends E> mapper)
long
substitute(Predicate<? super E> predicate, Function<E,E> mapper)
BulkList<E>
swap(long indexA, long indexB)
BulkList<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.BulkList<E>
toReversed()
Creates a newXBasicList
with the reversed order of elements.String
toString()
void
truncate()
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 targetConsumer
for 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
internalGetStorageArray
Methods inherited from class one.microstream.collections.AbstractArrayCollection
marker, newArray, newArray, pow2BoundMaxed
Methods inherited from class one.microstream.collections.AbstractExtendedCollection
ensureFreeArrayCapacity, validateIndex
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface one.microstream.collections.interfaces.CapacityCarrying
remainingCapacity
Methods inherited from interface one.microstream.collections.interfaces.CapacityExtendable
currentFreeCapacity
-
Constructor Details
-
BulkList
public BulkList()Default constructor instantiating an empty instance with default (minimum) capacity. -
BulkList
Default constructor instantiating an instance with default (minimum) capacity and the given element already included.- Parameters:
initialElement
- that will be included in the list
-
BulkList
public BulkList(int initialCapacity)Initial capacity constructor instantiating an empty instance with a given initial capacity.The actual initial capacity is the highest of the following three values:
Integer
MAX_VALUE, if the given initial capacity is greater than 2^30.- The lowest power of two value that is equal to or greater than the given initial capacity.
- The default (minimum) capacity.
- Parameters:
initialCapacity
- the desired custom initial capacity.
-
BulkList
Copy constructor that instantiates a new instance with a copy of the passed original instance's data and same size.- Parameters:
original
- the instance to be copied.- Throws:
NullPointerException
- ifnull
was passed.- See Also:
copy()
-
BulkList
Convenience initial data constructor, instantiating a new instance containing all elements of the passed array. The element size of the new instance will be equal to the passed array's length.Note that providing no element at all in the VarArgs parameter will automatically cause the default constructor
BulkList()
to be used instead. Explicitly providing annull
array reference will cause aNullPointerException
.- Parameters:
elements
- the initial elements for the new instance.- Throws:
NullPointerException
- if an explicitnull
array reference was passed.- See Also:
BulkList()
-
BulkList
Detailed initializing constructor allowing to specify initial capacity and a custom array range of initial data.The actual initial capacity will be calculated based on the higher of the two values
initialCapacity
andsrcLength
as described inBulkList(int)
.The specified initial elements array range is copied via
System.arraycopy(Object, int, Object, int, int)
.- Parameters:
initialCapacity
- the desired initial capacity for the new instance.src
- the source array containg the desired range of initial elements.srcStart
- the start index of the desired range of initial elements in the source array.srcLength
- the length of the desired range of initial elements in the source array.
-
-
Method Details
-
Immurer
- Type Parameters:
E
- type of contained elements- Returns:
- Function that creates an immutable, typed list out of a
BulkList
-
Builder
Creates anAggregator
that accepts elements and adds them to a newBulkList
.- Type Parameters:
E
- type of contained elements- Returns:
- The created aggregator.
-
Builder
Creates aAggregator
that accepts elements and adds them to a newBulkList
with a specific initial capacity.- Type Parameters:
E
- type of contained elements- Parameters:
initialCapacity
- of the list- Returns:
- The created aggregator
-
New
Pseudo-constructor method to create a newBulkList
instance with default (minimum) capacity.- Type Parameters:
E
- type of contained elements- Returns:
- a new
BulkList
instance.
-
New
Pseudo-constructor method to create a newBulkList
instance with a given initial capacity.- Type Parameters:
E
- type of contained elements- Parameters:
initialCapacity
- the desired custom initial capacity.- Returns:
- a new
BulkList
instance.
-
NewFromSingle
Pseudo-constructor method to create a newBulkList
instance with default (minimum) capacity and the given element already included.- Type Parameters:
E
- type of contained elements- Parameters:
initialElement
- that will be included in the list- Returns:
- a new
BulkList
instance.
-
New
Pseudo-constructor method to create a newBulkList
instance containing all elements of the passed array. The element size of the new instance will be equal to the passed arrays length.- Type Parameters:
E
- type of contained elements- Parameters:
initialElements
- the initial elements for the new instance.- Returns:
- a new
BulkList
instance. - Throws:
NullPointerException
- if an explicitnull
array reference was passed.
-
New
Pseudo-constructor method to create a newBulkList
instance and adds all the given elements to it.- Type Parameters:
E
- type of contained elements- Parameters:
initialElements
- to add to the created instance- Returns:
- a new
BulkList
instance.
-
New
Pseudo-constructor method to create a newBulkList
instance and adds all the given elements to it.- Type Parameters:
E
- type of contained elements- Parameters:
initialElements
- to add to the created instance- Returns:
- a new
BulkList
instance.
-
New
Pseudo-constructor method to create a newBulkList
instance with the needed amount of capacity and adds all elements to it.- Type Parameters:
E
- type of contained elements- Parameters:
initialElements
- to add to the created instance- Returns:
- a new
BulkList
instance.
-
internalGetStorageArray
Description copied from class:AbstractSimpleArrayCollection
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.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:
internalGetStorageArray
in classAbstractSimpleArrayCollection<E>
- Returns:
- the storage array used by the list, containing all elements in straight order.
-
internalSize
protected final int internalSize()- Specified by:
internalSize
in classAbstractSimpleArrayCollection<E>
-
internalGetSectionIndices
protected int[] internalGetSectionIndices()Description copied from class:AbstractSectionedArrayCollection
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.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:
internalGetSectionIndices
in classAbstractSectionedArrayCollection<E>
- Returns:
- a list of index pairs defining all sections of the storage array in logical order.
-
internalCountingAddAll
- Specified by:
internalCountingAddAll
in classAbstractExtendedCollection<E>
- Throws:
UnsupportedOperationException
-
internalCountingAddAll
protected int internalCountingAddAll(E[] elements, int offset, int length) throws UnsupportedOperationException- Specified by:
internalCountingAddAll
in classAbstractExtendedCollection<E>
- Throws:
UnsupportedOperationException
-
internalCountingAddAll
protected int internalCountingAddAll(XGettingCollection<? extends E> elements) throws UnsupportedOperationException- Specified by:
internalCountingAddAll
in classAbstractExtendedCollection<E>
- Throws:
UnsupportedOperationException
-
internalCountingPutAll
- Specified by:
internalCountingPutAll
in classAbstractExtendedCollection<E>
- Throws:
UnsupportedOperationException
-
internalCountingPutAll
protected int internalCountingPutAll(E[] elements, int offset, int length) throws UnsupportedOperationException- Specified by:
internalCountingPutAll
in classAbstractExtendedCollection<E>
- Throws:
UnsupportedOperationException
-
internalCountingPutAll
protected int internalCountingPutAll(XGettingCollection<? extends E> elements) throws UnsupportedOperationException- Specified by:
internalCountingPutAll
in classAbstractExtendedCollection<E>
- Throws:
UnsupportedOperationException
-
equality
- Specified by:
equality
in interfaceXGettingCollection<E>
- Returns:
- The current
Equalator
for this collection instance, which in this case is always a '=='-operation. (identity check)
-
copy
Description copied from interface:XGettingCollection
Creates a true copy of this collection which references the same elements as this collection does at the time the method is called. The elements themselves are NOT copied (no deep copying).
The type of the returned set is the same as of this list if possible.- Specified by:
copy
in interfaceCopyable
- Specified by:
copy
in interfaceXAddGetCollection<E>
- Specified by:
copy
in interfaceXBag<E>
- Specified by:
copy
in interfaceXBasicList<E>
- Specified by:
copy
in interfaceXBasicSequence<E>
- Specified by:
copy
in interfaceXCollection<E>
- Specified by:
copy
in interfaceXDecreasingList<E>
- Specified by:
copy
in interfaceXDecreasingSequence<E>
- Specified by:
copy
in interfaceXGettingBag<E>
- Specified by:
copy
in interfaceXGettingCollection<E>
- Specified by:
copy
in interfaceXGettingList<E>
- Specified by:
copy
in interfaceXGettingSequence<E>
- Specified by:
copy
in interfaceXIncreasingList<E>
- Specified by:
copy
in interfaceXIncreasingSequence<E>
- Specified by:
copy
in interfaceXList<E>
- Specified by:
copy
in interfaceXProcessingBag<E>
- Specified by:
copy
in interfaceXProcessingList<E>
- Specified by:
copy
in interfaceXPutGetCollection<E>
- Specified by:
copy
in interfaceXPutGetList<E>
- Specified by:
copy
in interfaceXPutGetSequence<E>
- Specified by:
copy
in interfaceXReplacingBag<E>
- Specified by:
copy
in interfaceXSequence<E>
- Specified by:
copy
in interfaceXSettingList<E>
- Specified by:
copy
in interfaceXSettingSequence<E>
- Specified by:
copy
in interfaceXSortableSequence<E>
- Returns:
- a copy of this list
-
immure
Description copied from interface:XGettingCollection
Provides 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:
immure
in interfaceXGettingBag<E>
- Specified by:
immure
in interfaceXGettingCollection<E>
- Specified by:
immure
in interfaceXGettingList<E>
- Specified by:
immure
in interfaceXGettingSequence<E>
- Specified by:
immure
in interfaceXProcessingBag<E>
- Returns:
- an immutable copy of this collection instance.
-
toReversed
Description copied from interface:XBasicList
Creates a newXBasicList
with 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:
toReversed
in interfaceXBasicList<E>
- Specified by:
toReversed
in interfaceXBasicSequence<E>
- Specified by:
toReversed
in interfaceXDecreasingList<E>
- Specified by:
toReversed
in interfaceXDecreasingSequence<E>
- Specified by:
toReversed
in interfaceXGettingList<E>
- Specified by:
toReversed
in interfaceXGettingSequence<E>
- Specified by:
toReversed
in interfaceXIncreasingList<E>
- Specified by:
toReversed
in interfaceXIncreasingSequence<E>
- Specified by:
toReversed
in interfaceXList<E>
- Specified by:
toReversed
in interfaceXProcessingList<E>
- Specified by:
toReversed
in interfaceXProcessingSequence<E>
- Specified by:
toReversed
in interfaceXPutGetList<E>
- Specified by:
toReversed
in interfaceXPutGetSequence<E>
- Specified by:
toReversed
in interfaceXSequence<E>
- Specified by:
toReversed
in interfaceXSettingList<E>
- Specified by:
toReversed
in interfaceXSettingSequence<E>
- Specified by:
toReversed
in interfaceXSortableSequence<E>
- Returns:
- new reversed collection
-
toArray
Description copied from interface:XGettingCollection
Returns 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:
toArray
in interfaceXGettingCollection<E>
- Parameters:
type
- theClass
representing typeE
at runtime.- Returns:
- a typed array containing all of the elements in this collection
-
iterate
Description copied from interface:XIterable
Executes the given procedure for each element of theXIterable
until 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
Iterates over all elements of the collections and calls the joiner with each element and the aggregate.- Specified by:
join
in interfaceXGettingCollection<E>
- Specified by:
join
in interfaceXJoinable<E>
- Type Parameters:
A
- type of aggregate- Parameters:
joiner
- is the actual function to do the joiningaggregate
- where to join into- Returns:
- the joined aggregate
- See Also:
AbstractArrayStorage.join(Object[], int, BiConsumer, Object)
-
iterateIndexed
Description copied from interface:XIndexIterable
Iterates over elements with theIndexedAcceptor
to use not only the element itself but also its coherent index.- Specified by:
iterateIndexed
in interfaceXIndexIterable<E>
- Type Parameters:
P
- type of procedure- Parameters:
procedure
- which is executed when iterating- Returns:
- Given procedure
-
count
Count how many times this element matches another element in the collection using theEqualator
.
Does not throwNullPointerException
if element isnull
.- Specified by:
count
in interfaceXGettingCollection<E>
- Parameters:
element
- to count- Returns:
- Amount of matches
-
countBy
Count how many matches are found using the given predicate on each element of the collection.
ThrowsNullPointerException
if predicate isnull
.- Specified by:
countBy
in interfaceXGettingCollection<E>
- Parameters:
predicate
- defines which elements are counted and which are not- Returns:
- Amount of matches
-
indexOf
- Specified by:
indexOf
in interfaceXGettingSequence<E>
-
indexBy
Description copied from interface:XGettingSequence
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.Basically the opposite of
XGettingSequence.lastIndexBy(Predicate)
- Specified by:
indexBy
in interfaceXGettingSequence<E>
- Parameters:
predicate
- to define a valid element- Returns:
- The index of the first positively tested element.
-
lastIndexOf
- Specified by:
lastIndexOf
in interfaceXGettingSequence<E>
-
lastIndexBy
Description copied from interface:XGettingSequence
Iterates backwards through the collection and returns the index of the last element that the passedPredicate
applies 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)
, sincescan
iterates through all elements.- Specified by:
lastIndexBy
in interfaceXGettingSequence<E>
- Parameters:
predicate
- to define a valid element- Returns:
- the index of the last positively tested element.
-
maxIndex
- Specified by:
maxIndex
in interfaceXGettingSequence<E>
-
minIndex
- Specified by:
minIndex
in interfaceXGettingSequence<E>
-
scan
Description copied from interface:XGettingSequence
Iterates through the collection and returns the index of the last element that the passedPredicate
applied 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:
scan
in interfaceXGettingSequence<E>
- Parameters:
predicate
- to define a valid element- Returns:
- the index of the last positively tested element.
-
get
Gets the first element in the collection. This is a parameterless alias forat(0)
.first()
is an alias for this method.- Specified by:
get
in interfaceXGettingCollection<E>
- Specified by:
get
in interfaceXGettingSequence<E>
- Returns:
- the first element.
- Throws:
NoSuchElementException
- if collection is empty- See Also:
at(long)
,first()
,last()
-
first
Description copied from interface:XGettingSequence
Gets first element or throwsIndexOutOfBoundsException
if the collection is empty.Is an alias for
XGettingSequence.get()
.- Specified by:
first
in interfaceXGettingSequence<E>
- Returns:
- First element
- Throws:
IndexBoundsException
-
last
Description copied from interface:XGettingSequence
Gets last element or throwsIndexOutOfBoundsException
if the collection is empty.- Specified by:
last
in interfaceXGettingSequence<E>
- Returns:
- Last element
- Throws:
IndexBoundsException
-
poll
Description copied from interface:XGettingSequence
Gets first element or null if the collection is empty.- Specified by:
poll
in interfaceXGettingSequence<E>
- Returns:
- First element or null
-
peek
Description copied from interface:XGettingSequence
Gets last element or null if the collection is empty.
This behaves like peeking on a stack without pop.- Specified by:
peek
in interfaceXGettingSequence<E>
- Returns:
- Last element or null
-
search
Description copied from interface:XGettingCollection
Returns the first contained element matching the passed predicate.- Specified by:
search
in interfaceXGettingCollection<E>
- Parameters:
predicate
- defines which element is searched- Returns:
- Matching element
-
seek
Description copied from interface:XGettingCollection
Returns the first contained element matching the passed sample as defined by the collection's equality logic or null, if no fitting element is contained. (For collections using referential equality, this method is basically just a variation ofXGettingCollection.contains(Object)
with a different return type. For collections with data-dependant equality, the returned element might be the same as the passed one or a data-wise equal one, depending on the content of the collection)- Specified by:
seek
in interfaceXGettingCollection<E>
- Parameters:
sample
- to seek in the collection- Returns:
- the first contained element matching the passed sample
-
max
- Specified by:
max
in interfaceXGettingCollection<E>
-
min
- Specified by:
min
in interfaceXGettingCollection<E>
-
hasVolatileElements
public final boolean hasVolatileElements()Description copied from interface:ExtendedCollection
Tells if this collection contains volatile elements.
An element is volatile, if it can become no longer reachable by the collection without being removed from the collection. Examples areWeakReference
ofSoftReference
or implementations of collection entries that remove the element contained in an entry by some means outside the collection.
Note thatWeakReference
instances that are added to a a simple (non-volatile) implementation of a collection do not make the collection volatile, as the elements themselves (the reference instances) are still strongly referenced.- Specified by:
hasVolatileElements
in interfaceExtendedCollection<E>
- Specified by:
hasVolatileElements
in interfaceXGettingCollection<E>
- Returns:
true
if the collection contains volatile elements.
-
nullAllowed
public final boolean nullAllowed()Description copied from interface:ExtendedCollection
Defines if null-elements are allowed inside the collection or not.- Specified by:
nullAllowed
in interfaceExtendedCollection<E>
- Returns:
- Always true in
BulkList
, because null is generally allowed.
-
isSorted
Description copied from interface:XGettingSequence
Tests if the collection is sorted according to the given comparator.- Specified by:
isSorted
in interfaceXGettingSequence<E>
- Parameters:
comparator
- defines if elements are sorted- Returns:
- true if it sorted, false if not
-
containsSearched
- Specified by:
containsSearched
in interfaceXGettingCollection<E>
-
applies
Description copied from interface:XGettingCollection
Tests each element of the collection on the given predicate.- Specified by:
applies
in 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 final boolean nullContained()- Specified by:
nullContained
in interfaceXGettingCollection<E>
-
containsId
Description copied from interface:XGettingCollection
Special version of contains() that guarantees to use identity comparison (" == ") when searching for the given element regardless of the collection's internal logic.
This method has the same behavior asXGettingCollection.containsSearched(Predicate)
with aPredicate
implementation that checks for object identity. The only difference is a performance and usability advantage- Specified by:
containsId
in interfaceXGettingCollection<E>
- Parameters:
element
- the element to be searched in the collection by identity.- Returns:
- whether this collection contains exactly the given element.
-
contains
Checks if the given element is contained in the collection.
In contrast to theXGettingCollection.containsId(Object)
method, this method uses the internalEqualator
defined by the collection itself.In
BulkList
this method is identical to thecontainsId(Object)
method, since theEqualator
is the defaultEqualator.identity()
.- Specified by:
contains
in 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:
containsAll
in interfaceXGettingCollection<E>
- Parameters:
elements
- to be searched in the collection.- Returns:
- Whether this collection contains all given elements as specified by the
Equalator
.
-
equals
public final boolean equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)- Specified by:
equals
in interfaceXGettingCollection<E>
- Parameters:
samples
- is the collection which is checked for equalityequalator
- is used to check the equality of the collections- Returns:
true
if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)
yieldstrue
-
equalsContent
public final boolean equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)Description copied from interface:XGettingCollection
Returnstrue
if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.Note that for colletion types that don't have a defined order of elements, this method is hardly usable (as is
XGettingCollection.equals(Object)
for them as defined inCollection
). The core problem of comparing collections that have no defined order is that they aren't really reliably comparable to any other collection.- Specified by:
equalsContent
in interfaceXGettingCollection<E>
- Parameters:
samples
- is the collection which is checked for equalityequalator
- the equalator to use to determine the equality of each element- Returns:
true
if this list is equal to the passed list,false
otherwise
-
intersect
public final <C extends Consumer<? super E>> C intersect(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)Description copied from interface:XGettingCollection
Tests equality between each element of the two lists and callsConsumer.accept(Object)
on the targetConsumer
for the equal elements.
Therefore it effectively creates a mathematical intersection between the two collections.Since all MicroStream Collections implement the
Consumer
interface, 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 inintersection
containing 2 and 3.- Specified by:
intersect
in interfaceXGettingCollection<E>
- Type Parameters:
C
- type of the target- 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 final <C extends Consumer<? super E>> C except(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)Description copied from interface:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
for each element of this collection that is not contained in the other collection (through the given equalator).Since all MicroStream Collections implement the
Consumer
interface, 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 inexceptCollection
containing 1.- Specified by:
except
in 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 final <C extends Consumer<? super E>> C union(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)Description copied from interface:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
for 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
Consumer
interface, 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 inunion
containing 1, 2, 3 and 4.- Specified by:
union
in interfaceXGettingCollection<E>
- Type Parameters:
C
- type of the target- 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:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection.Since all MicroStream Collections implement the
Consumer
interface, new collections can be used as target.Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3); BulkList<Integer> copiedCollection = collection1.copyTo(BulkList.New());
Results incopiedCollection
containing 1, 2 and 3.- Specified by:
copyTo
in interfaceXGettingCollection<E>
- Type Parameters:
C
- type of the target- Parameters:
target
- on which theConsumer.accept(Object)
is called for all elements of this collection.- Returns:
- Given target
-
filterTo
Description copied from interface:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection which testtrue
on the given predicate.Since all MicroStream Collections implement the
Consumer
interface, 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 infilteredCollection
containing 2.- Specified by:
filterTo
in interfaceXGettingCollection<E>
- Type Parameters:
C
- type of the target- Parameters:
target
- on which theConsumer.accept(Object)
is called for elements that testtrue
.predicate
- on which to test all elements.- Returns:
- Given target
-
distinct
Description copied from interface:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
for 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
Consumer
interface, 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 indistinctCollection
containing 1, 2 and 3.- Specified by:
distinct
in interfaceXGettingCollection<E>
- Type Parameters:
C
- type of the target- Parameters:
target
- on which theConsumer.accept(Object)
is called for every distinct element of this collection.- Returns:
- Given target
-
distinct
Description copied from interface:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
for 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
Consumer
interface, 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 indistinctCollection
containing 1, 2 and 3.- Specified by:
distinct
in interfaceXGettingCollection<E>
- Type Parameters:
C
- type of the target- 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:XGettingSequence
Iterates through all the elements of the given indices and calls theConsumer.accept(Object)
on the targetConsumer
.- Specified by:
copySelection
in 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:XGettingCollection
Creates 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:
view
in interfaceXGettingBag<E>
- Specified by:
view
in interfaceXGettingCollection<E>
- Specified by:
view
in interfaceXGettingList<E>
- Specified by:
view
in interfaceXGettingSequence<E>
- Specified by:
view
in interfaceXProcessingBag<E>
- Returns:
- new read-only collection to view this collection
-
view
Description copied from interface:XGettingSequence
Creates 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:
view
in interfaceXGettingList<E>
- Specified by:
view
in interfaceXGettingSequence<E>
- Specified by:
view
in 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:XOrderingSequence
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.Does not expand or shrink the capacity of the sequence.
Throws a
IndexExceededException
if sourceIndex or targetIndex are greater than the size of the sequence.- Specified by:
shiftTo
in interfaceXList<E>
- Specified by:
shiftTo
in interfaceXOrderingSequence<E>
- Specified by:
shiftTo
in 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:XOrderingSequence
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.Does not expand or shrink the capacity of the sequence.
Throws a
IndexExceededException
if sourceIndex or targetIndex exceed the size of the sequence.- Specified by:
shiftTo
in interfaceXList<E>
- Specified by:
shiftTo
in interfaceXOrderingSequence<E>
- Specified by:
shiftTo
in 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:XOrderingSequence
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. ("to the right")Does not expand or shrink the capacity of the sequence.
Throws a
IndexExceededException
if sourceIndex or targetIndex (sourceIndex+distance) exceed the size of the sequence.- Specified by:
shiftBy
in interfaceXList<E>
- Specified by:
shiftBy
in interfaceXOrderingSequence<E>
- Specified by:
shiftBy
in 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:XOrderingSequence
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. ("to the right")Does not expand or shrink the capacity of the sequence.
Throws a
IndexExceededException
if sourceIndex or targetIndex (sourceIndex+distance+length) exceed the size of the sequence.- Specified by:
shiftBy
in interfaceXList<E>
- Specified by:
shiftBy
in interfaceXOrderingSequence<E>
- Specified by:
shiftBy
in 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 final BulkList<E> swap(long indexA, long indexB) throws IndexOutOfBoundsException, ArrayIndexOutOfBoundsException- Specified by:
swap
in interfaceXDecreasingList<E>
- Specified by:
swap
in interfaceXDecreasingSequence<E>
- Specified by:
swap
in interfaceXIncreasingList<E>
- Specified by:
swap
in interfaceXIncreasingSequence<E>
- Specified by:
swap
in interfaceXList<E>
- Specified by:
swap
in interfaceXOrderingSequence<E>
- Specified by:
swap
in interfaceXSettingList<E>
- Specified by:
swap
in interfaceXSettingSequence<E>
- Specified by:
swap
in interfaceXSortableSequence<E>
- Throws:
IndexOutOfBoundsException
ArrayIndexOutOfBoundsException
-
swap
- Specified by:
swap
in interfaceXDecreasingList<E>
- Specified by:
swap
in interfaceXDecreasingSequence<E>
- Specified by:
swap
in interfaceXIncreasingList<E>
- Specified by:
swap
in interfaceXIncreasingSequence<E>
- Specified by:
swap
in interfaceXList<E>
- Specified by:
swap
in interfaceXOrderingSequence<E>
- Specified by:
swap
in interfaceXSettingList<E>
- Specified by:
swap
in interfaceXSettingSequence<E>
- Specified by:
swap
in interfaceXSortableSequence<E>
-
reverse
Description copied from interface:XSortableSequence
Reverses 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:
reverse
in interfaceXDecreasingList<E>
- Specified by:
reverse
in interfaceXDecreasingSequence<E>
- Specified by:
reverse
in interfaceXIncreasingList<E>
- Specified by:
reverse
in interfaceXIncreasingSequence<E>
- Specified by:
reverse
in interfaceXList<E>
- Specified by:
reverse
in interfaceXOrderingSequence<E>
- Specified by:
reverse
in interfaceXSettingList<E>
- Specified by:
reverse
in interfaceXSettingSequence<E>
- Specified by:
reverse
in interfaceXSortableSequence<E>
- Returns:
- this
-
setFirst
- Specified by:
setFirst
in interfaceXSettingSequence<E>
-
setLast
- Specified by:
setLast
in interfaceXSettingSequence<E>
-
setAll
- Specified by:
setAll
in interfaceXDecreasingList<E>
- Specified by:
setAll
in interfaceXDecreasingSequence<E>
- Specified by:
setAll
in interfaceXIncreasingList<E>
- Specified by:
setAll
in interfaceXList<E>
- Specified by:
setAll
in interfaceXSettingList<E>
- Specified by:
setAll
in interfaceXSettingSequence<E>
-
set
- Specified by:
set
in interfaceXDecreasingList<E>
- Specified by:
set
in interfaceXDecreasingSequence<E>
- Specified by:
set
in interfaceXIncreasingList<E>
- Specified by:
set
in interfaceXList<E>
- Specified by:
set
in interfaceXSettingList<E>
- Specified by:
set
in interfaceXSettingSequence<E>
-
set
public final BulkList<E> set(long offset, XGettingSequence<? extends E> elements, long elementsOffset, long elementsLength)- Specified by:
set
in interfaceXDecreasingList<E>
- Specified by:
set
in interfaceXDecreasingSequence<E>
- Specified by:
set
in interfaceXIncreasingList<E>
- Specified by:
set
in interfaceXList<E>
- Specified by:
set
in interfaceXSettingList<E>
- Specified by:
set
in interfaceXSettingSequence<E>
-
fill
Description copied from interface:XSettingList
Fills all slots from the offset to the offset+length with the given element, regardless of whether or not a slot isnull
.- Specified by:
fill
in interfaceXDecreasingList<E>
- Specified by:
fill
in interfaceXIncreasingList<E>
- Specified by:
fill
in interfaceXList<E>
- Specified by:
fill
in 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:Sortable
Sorts this collection according to the given comparator and returns itself.- Specified by:
sort
in interfaceSortable<E>
- Specified by:
sort
in interfaceXDecreasingList<E>
- Specified by:
sort
in interfaceXDecreasingSequence<E>
- Specified by:
sort
in interfaceXIncreasingList<E>
- Specified by:
sort
in interfaceXIncreasingSequence<E>
- Specified by:
sort
in interfaceXList<E>
- Specified by:
sort
in interfaceXSequence<E>
- Specified by:
sort
in interfaceXSettingList<E>
- Specified by:
sort
in interfaceXSettingSequence<E>
- Specified by:
sort
in interfaceXSortableSequence<E>
- Parameters:
comparator
- to sort this collection- Returns:
- this
-
replaceOne
Replaces the first element that is equal to the given element with the replacement and then returns true.If the element is equal is defined by a '==' comparation (same).
- Specified by:
replaceOne
in interfaceXReplacingBag<E>
- Parameters:
element
- to replacereplacement
- for the found element- Returns:
true
if element is found,false
if not
-
replaceOne
- Specified by:
replaceOne
in interfaceXReplacingBag<E>
-
replace
- Specified by:
replace
in interfaceXReplacingBag<E>
-
replace
- Specified by:
replace
in interfaceXReplacingBag<E>
-
replaceAll
- Specified by:
replaceAll
in interfaceXReplacingBag<E>
-
substitute
- Specified by:
substitute
in interfaceXReplacingCollection<E>
-
substitute
- Specified by:
substitute
in interfaceXReplacingBag<E>
-
currentCapacity
public final long currentCapacity()Description copied from interface:CapacityExtendable
Returns 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:
currentCapacity
in interfaceCapacityExtendable
- Returns:
- the current capacity of this instance before a rebuild is required.
-
maximumCapacity
public final long maximumCapacity()Description copied from interface:CapacityCarrying
Returns the maximum amount of elements this carrier instance can contain.
The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g.Integer.MAX_VALUE
)- Specified by:
maximumCapacity
in interfaceCapacityCarrying
- Returns:
- the maximum amount of elements this carrier instance can contain.
-
isFull
public final boolean isFull()- Specified by:
isFull
in interfaceCapacityCarrying
- Returns:
- true if the current capacity cannot be increased any more.
-
optimize
public final long optimize()Description copied from interface:OptimizableCollection
Optimizes the internal storage of this collection and returns the storage size of the collection after the process is complete.- Specified by:
optimize
in interfaceOptimizableCollection
- Specified by:
optimize
in interfaceXRemovingCollection<E>
- Returns:
- the storage size of the collection after the optimzation.
-
ensureFreeCapacity
Description copied from interface:CapacityExtendable
Ensures 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:
ensureFreeCapacity
in interfaceCapacityExtendable
- Parameters:
requiredFreeCapacity
- the capacity to ensure- Returns:
- this
-
ensureCapacity
- Specified by:
ensureCapacity
in interfaceCapacityExtendable
-
accept
-
add
Description copied from interface:XAddingCollection
Adds the passed element.- Specified by:
add
in interfaceXAddingCollection<E>
- Parameters:
element
- to add- Returns:
true
if element was added;false
if not
-
addAll
- Specified by:
addAll
in interfaceXAddGetCollection<E>
- Specified by:
addAll
in interfaceXAddingBag<E>
- Specified by:
addAll
in interfaceXAddingCollection<E>
- Specified by:
addAll
in interfaceXAddingList<E>
- Specified by:
addAll
in interfaceXAddingSequence<E>
- Specified by:
addAll
in interfaceXBag<E>
- Specified by:
addAll
in interfaceXBasicList<E>
- Specified by:
addAll
in interfaceXBasicSequence<E>
- Specified by:
addAll
in interfaceXCollection<E>
- Specified by:
addAll
in interfaceXExpandingList<E>
- Specified by:
addAll
in interfaceXExpandingSequence<E>
- Specified by:
addAll
in interfaceXExtendingList<E>
- Specified by:
addAll
in interfaceXExtendingSequence<E>
- Specified by:
addAll
in interfaceXIncreasingList<E>
- Specified by:
addAll
in interfaceXIncreasingSequence<E>
- Specified by:
addAll
in interfaceXInputtingList<E>
- Specified by:
addAll
in interfaceXInputtingSequence<E>
- Specified by:
addAll
in interfaceXInsertingSequence<E>
- Specified by:
addAll
in interfaceXList<E>
- Specified by:
addAll
in interfaceXPutGetCollection<E>
- Specified by:
addAll
in interfaceXPutGetList<E>
- Specified by:
addAll
in interfaceXPutGetSequence<E>
- Specified by:
addAll
in interfaceXPuttingBag<E>
- Specified by:
addAll
in interfaceXPuttingList<E>
- Specified by:
addAll
in interfaceXSequence<E>
-
addAll
- Specified by:
addAll
in interfaceXAddGetCollection<E>
- Specified by:
addAll
in interfaceXAddingBag<E>
- Specified by:
addAll
in interfaceXAddingCollection<E>
- Specified by:
addAll
in interfaceXAddingList<E>
- Specified by:
addAll
in interfaceXAddingSequence<E>
- Specified by:
addAll
in interfaceXBag<E>
- Specified by:
addAll
in interfaceXBasicList<E>
- Specified by:
addAll
in interfaceXBasicSequence<E>
- Specified by:
addAll
in interfaceXCollection<E>
- Specified by:
addAll
in interfaceXExpandingList<E>
- Specified by:
addAll
in interfaceXExpandingSequence<E>
- Specified by:
addAll
in interfaceXExtendingList<E>
- Specified by:
addAll
in interfaceXExtendingSequence<E>
- Specified by:
addAll
in interfaceXIncreasingList<E>
- Specified by:
addAll
in interfaceXIncreasingSequence<E>
- Specified by:
addAll
in interfaceXInputtingList<E>
- Specified by:
addAll
in interfaceXInputtingSequence<E>
- Specified by:
addAll
in interfaceXInsertingSequence<E>
- Specified by:
addAll
in interfaceXList<E>
- Specified by:
addAll
in interfaceXPutGetCollection<E>
- Specified by:
addAll
in interfaceXPutGetList<E>
- Specified by:
addAll
in interfaceXPutGetSequence<E>
- Specified by:
addAll
in interfaceXPuttingBag<E>
- Specified by:
addAll
in interfaceXPuttingList<E>
- Specified by:
addAll
in interfaceXSequence<E>
-
addAll
- Specified by:
addAll
in interfaceXAddGetCollection<E>
- Specified by:
addAll
in interfaceXAddingBag<E>
- Specified by:
addAll
in interfaceXAddingCollection<E>
- Specified by:
addAll
in interfaceXAddingList<E>
- Specified by:
addAll
in interfaceXAddingSequence<E>
- Specified by:
addAll
in interfaceXBag<E>
- Specified by:
addAll
in interfaceXBasicList<E>
- Specified by:
addAll
in interfaceXBasicSequence<E>
- Specified by:
addAll
in interfaceXCollection<E>
- Specified by:
addAll
in interfaceXExpandingList<E>
- Specified by:
addAll
in interfaceXExpandingSequence<E>
- Specified by:
addAll
in interfaceXExtendingList<E>
- Specified by:
addAll
in interfaceXExtendingSequence<E>
- Specified by:
addAll
in interfaceXIncreasingList<E>
- Specified by:
addAll
in interfaceXIncreasingSequence<E>
- Specified by:
addAll
in interfaceXInputtingList<E>
- Specified by:
addAll
in interfaceXInputtingSequence<E>
- Specified by:
addAll
in interfaceXInsertingSequence<E>
- Specified by:
addAll
in interfaceXList<E>
- Specified by:
addAll
in interfaceXPutGetCollection<E>
- Specified by:
addAll
in interfaceXPutGetList<E>
- Specified by:
addAll
in interfaceXPutGetSequence<E>
- Specified by:
addAll
in interfaceXPuttingBag<E>
- Specified by:
addAll
in interfaceXPuttingList<E>
- Specified by:
addAll
in interfaceXSequence<E>
-
nullAdd
public final boolean nullAdd()- Specified by:
nullAdd
in interfaceXAddingCollection<E>
-
nullPut
public final boolean nullPut()- Specified by:
nullPut
in interfaceXPuttingCollection<E>
-
put
Adds the specified element to this collection if it is not already present (optional operation).In this implementation it is identical to
add(Object)
.- Specified by:
put
in interfaceXPuttingCollection<E>
- Parameters:
element
- to add- Returns:
- true if this collection did not already contain the specified element
-
putAll
Description copied from interface:XPuttingBag
Adds 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:
putAll
in interfaceXBag<E>
- Specified by:
putAll
in interfaceXBasicList<E>
- Specified by:
putAll
in interfaceXBasicSequence<E>
- Specified by:
putAll
in interfaceXCollection<E>
- Specified by:
putAll
in interfaceXExpandingList<E>
- Specified by:
putAll
in interfaceXExpandingSequence<E>
- Specified by:
putAll
in interfaceXIncreasingList<E>
- Specified by:
putAll
in interfaceXIncreasingSequence<E>
- Specified by:
putAll
in interfaceXInputtingList<E>
- Specified by:
putAll
in interfaceXInputtingSequence<E>
- Specified by:
putAll
in interfaceXList<E>
- Specified by:
putAll
in interfaceXPutGetCollection<E>
- Specified by:
putAll
in interfaceXPutGetList<E>
- Specified by:
putAll
in interfaceXPutGetSequence<E>
- Specified by:
putAll
in interfaceXPuttingBag<E>
- Specified by:
putAll
in interfaceXPuttingCollection<E>
- Specified by:
putAll
in interfaceXPuttingList<E>
- Specified by:
putAll
in interfaceXPuttingSequence<E>
- Specified by:
putAll
in interfaceXSequence<E>
- Parameters:
elements
- to add- Returns:
- this
-
putAll
Description copied from interface:XPuttingBag
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.In this implementation it is identical to
XPuttingBag.addAll(Object[], int, int)
- Specified by:
putAll
in interfaceXBag<E>
- Specified by:
putAll
in interfaceXBasicList<E>
- Specified by:
putAll
in interfaceXBasicSequence<E>
- Specified by:
putAll
in interfaceXCollection<E>
- Specified by:
putAll
in interfaceXExpandingList<E>
- Specified by:
putAll
in interfaceXExpandingSequence<E>
- Specified by:
putAll
in interfaceXIncreasingList<E>
- Specified by:
putAll
in interfaceXIncreasingSequence<E>
- Specified by:
putAll
in interfaceXInputtingList<E>
- Specified by:
putAll
in interfaceXInputtingSequence<E>
- Specified by:
putAll
in interfaceXList<E>
- Specified by:
putAll
in interfaceXPutGetCollection<E>
- Specified by:
putAll
in interfaceXPutGetList<E>
- Specified by:
putAll
in interfaceXPutGetSequence<E>
- Specified by:
putAll
in interfaceXPuttingBag<E>
- Specified by:
putAll
in interfaceXPuttingCollection<E>
- Specified by:
putAll
in interfaceXPuttingList<E>
- Specified by:
putAll
in interfaceXPuttingSequence<E>
- Specified by:
putAll
in 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:XPuttingBag
Adds 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:
putAll
in interfaceXBag<E>
- Specified by:
putAll
in interfaceXBasicList<E>
- Specified by:
putAll
in interfaceXBasicSequence<E>
- Specified by:
putAll
in interfaceXCollection<E>
- Specified by:
putAll
in interfaceXExpandingList<E>
- Specified by:
putAll
in interfaceXExpandingSequence<E>
- Specified by:
putAll
in interfaceXIncreasingList<E>
- Specified by:
putAll
in interfaceXIncreasingSequence<E>
- Specified by:
putAll
in interfaceXInputtingList<E>
- Specified by:
putAll
in interfaceXInputtingSequence<E>
- Specified by:
putAll
in interfaceXList<E>
- Specified by:
putAll
in interfaceXPutGetCollection<E>
- Specified by:
putAll
in interfaceXPutGetList<E>
- Specified by:
putAll
in interfaceXPutGetSequence<E>
- Specified by:
putAll
in interfaceXPuttingBag<E>
- Specified by:
putAll
in interfaceXPuttingCollection<E>
- Specified by:
putAll
in interfaceXPuttingList<E>
- Specified by:
putAll
in interfaceXPuttingSequence<E>
- Specified by:
putAll
in interfaceXSequence<E>
- Parameters:
elements
- to add- Returns:
- this
-
prepend
- Specified by:
prepend
in interfaceXPrependingSequence<E>
-
prependAll
- Specified by:
prependAll
in interfaceXExpandingList<E>
- Specified by:
prependAll
in interfaceXExpandingSequence<E>
- Specified by:
prependAll
in interfaceXExtendingList<E>
- Specified by:
prependAll
in interfaceXExtendingSequence<E>
- Specified by:
prependAll
in interfaceXIncreasingList<E>
- Specified by:
prependAll
in interfaceXIncreasingSequence<E>
- Specified by:
prependAll
in interfaceXInputtingList<E>
- Specified by:
prependAll
in interfaceXInputtingSequence<E>
- Specified by:
prependAll
in interfaceXInsertingSequence<E>
- Specified by:
prependAll
in interfaceXList<E>
- Specified by:
prependAll
in interfaceXPrependingList<E>
- Specified by:
prependAll
in interfaceXPrependingSequence<E>
- Specified by:
prependAll
in interfaceXPreputtingList<E>
- Specified by:
prependAll
in interfaceXPreputtingSequence<E>
-
prependAll
- Specified by:
prependAll
in interfaceXExpandingList<E>
- Specified by:
prependAll
in interfaceXExpandingSequence<E>
- Specified by:
prependAll
in interfaceXExtendingList<E>
- Specified by:
prependAll
in interfaceXExtendingSequence<E>
- Specified by:
prependAll
in interfaceXIncreasingList<E>
- Specified by:
prependAll
in interfaceXIncreasingSequence<E>
- Specified by:
prependAll
in interfaceXInputtingList<E>
- Specified by:
prependAll
in interfaceXInputtingSequence<E>
- Specified by:
prependAll
in interfaceXInsertingSequence<E>
- Specified by:
prependAll
in interfaceXList<E>
- Specified by:
prependAll
in interfaceXPrependingList<E>
- Specified by:
prependAll
in interfaceXPrependingSequence<E>
- Specified by:
prependAll
in interfaceXPreputtingList<E>
- Specified by:
prependAll
in interfaceXPreputtingSequence<E>
-
prependAll
- Specified by:
prependAll
in interfaceXExpandingList<E>
- Specified by:
prependAll
in interfaceXExpandingSequence<E>
- Specified by:
prependAll
in interfaceXExtendingList<E>
- Specified by:
prependAll
in interfaceXExtendingSequence<E>
- Specified by:
prependAll
in interfaceXIncreasingList<E>
- Specified by:
prependAll
in interfaceXIncreasingSequence<E>
- Specified by:
prependAll
in interfaceXInputtingList<E>
- Specified by:
prependAll
in interfaceXInputtingSequence<E>
- Specified by:
prependAll
in interfaceXInsertingSequence<E>
- Specified by:
prependAll
in interfaceXList<E>
- Specified by:
prependAll
in interfaceXPrependingList<E>
- Specified by:
prependAll
in interfaceXPrependingSequence<E>
- Specified by:
prependAll
in interfaceXPreputtingList<E>
- Specified by:
prependAll
in interfaceXPreputtingSequence<E>
-
nullPrepend
public final boolean nullPrepend()- Specified by:
nullPrepend
in interfaceXPrependingSequence<E>
-
preput
- Specified by:
preput
in interfaceXPreputtingSequence<E>
-
preputAll
- Specified by:
preputAll
in interfaceXExpandingList<E>
- Specified by:
preputAll
in interfaceXExpandingSequence<E>
- Specified by:
preputAll
in interfaceXIncreasingList<E>
- Specified by:
preputAll
in interfaceXIncreasingSequence<E>
- Specified by:
preputAll
in interfaceXInputtingList<E>
- Specified by:
preputAll
in interfaceXInputtingSequence<E>
- Specified by:
preputAll
in interfaceXList<E>
- Specified by:
preputAll
in interfaceXPreputtingList<E>
- Specified by:
preputAll
in interfaceXPreputtingSequence<E>
-
preputAll
- Specified by:
preputAll
in interfaceXExpandingList<E>
- Specified by:
preputAll
in interfaceXExpandingSequence<E>
- Specified by:
preputAll
in interfaceXIncreasingList<E>
- Specified by:
preputAll
in interfaceXIncreasingSequence<E>
- Specified by:
preputAll
in interfaceXInputtingList<E>
- Specified by:
preputAll
in interfaceXInputtingSequence<E>
- Specified by:
preputAll
in interfaceXList<E>
- Specified by:
preputAll
in interfaceXPreputtingList<E>
- Specified by:
preputAll
in interfaceXPreputtingSequence<E>
-
preputAll
- Specified by:
preputAll
in interfaceXExpandingList<E>
- Specified by:
preputAll
in interfaceXExpandingSequence<E>
- Specified by:
preputAll
in interfaceXIncreasingList<E>
- Specified by:
preputAll
in interfaceXIncreasingSequence<E>
- Specified by:
preputAll
in interfaceXInputtingList<E>
- Specified by:
preputAll
in interfaceXInputtingSequence<E>
- Specified by:
preputAll
in interfaceXList<E>
- Specified by:
preputAll
in interfaceXPreputtingList<E>
- Specified by:
preputAll
in interfaceXPreputtingSequence<E>
-
nullPreput
public final boolean nullPreput()- Specified by:
nullPreput
in interfaceXPreputtingSequence<E>
-
insert
- Specified by:
insert
in interfaceXInsertingSequence<E>
-
insertAll
@SafeVarargs public final long insertAll(long index, E... elements) throws IndexOutOfBoundsException- Specified by:
insertAll
in interfaceXInsertingSequence<E>
- Throws:
IndexOutOfBoundsException
-
insertAll
- Specified by:
insertAll
in interfaceXInsertingSequence<E>
-
insertAll
- Specified by:
insertAll
in interfaceXInsertingSequence<E>
-
nullInsert
public final boolean nullInsert(long index)- Specified by:
nullInsert
in interfaceXInsertingSequence<E>
-
input
- Specified by:
input
in interfaceXInputtingSequence<E>
-
inputAll
@SafeVarargs public final long inputAll(long index, E... elements) throws IndexOutOfBoundsException- Specified by:
inputAll
in interfaceXInputtingSequence<E>
- Throws:
IndexOutOfBoundsException
-
inputAll
- Specified by:
inputAll
in interfaceXInputtingSequence<E>
-
inputAll
- Specified by:
inputAll
in interfaceXInputtingSequence<E>
-
nullInput
public final boolean nullInput(long index)- Specified by:
nullInput
in interfaceXInputtingSequence<E>
-
truncate
public final void truncate()Description copied from interface:XRemovingCollection
Clears (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:
truncate
in interfaceTruncateable
- Specified by:
truncate
in interfaceXRemovingCollection<E>
-
consolidate
public final long consolidate()Consolidates the internal storage of this collection by discarding all elements of the internal storage that have become obsolete or otherwise unneeded anymore. (e.g.WeakReference
entries whose reference has been cleared).In a
BulkList
, this does nothing.- Specified by:
consolidate
in interfaceConsolidatableCollection
- Specified by:
consolidate
in interfaceXRemovingCollection<E>
- Returns:
- the number of discarded entries.
-
removeOne
- Specified by:
removeOne
in interfaceXRemovingCollection<E>
-
retrieve
- Specified by:
retrieve
in interfaceXProcessingCollection<E>
-
retrieveBy
- Specified by:
retrieveBy
in interfaceXProcessingCollection<E>
-
remove
- Specified by:
remove
in interfaceXRemovingCollection<E>
-
nullRemove
public final long nullRemove()- Specified by:
nullRemove
in interfaceXRemovingCollection<E>
-
removeAt
public final E removeAt(long index) throws IndexOutOfBoundsException, ArrayIndexOutOfBoundsException- Specified by:
removeAt
in interfaceXProcessingSequence<E>
- Throws:
IndexOutOfBoundsException
ArrayIndexOutOfBoundsException
-
removeBy
- Specified by:
removeBy
in interfaceXProcessingCollection<E>
-
retainAll
Description copied from interface:XRemovingCollection
Removing 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:
retainAll
in interfaceXRemovingCollection<E>
- Parameters:
elements
- to retain- Returns:
- Amount of deleted elements
-
process
- Specified by:
process
in interfaceProcessable<E>
-
moveTo
- Specified by:
moveTo
in interfaceXProcessingCollection<E>
-
moveSelection
- Specified by:
moveSelection
in interfaceXProcessingSequence<E>
-
removeAll
- Specified by:
removeAll
in interfaceXRemovingCollection<E>
-
removeDuplicates
- Specified by:
removeDuplicates
in interfaceXProcessingCollection<E>
-
removeDuplicates
public final long removeDuplicates()- Specified by:
removeDuplicates
in interfaceXRemovingCollection<E>
-
fetch
- Specified by:
fetch
in interfaceXProcessingCollection<E>
-
pop
- Specified by:
pop
in interfaceXProcessingSequence<E>
-
pinch
- Specified by:
pinch
in interfaceXProcessingCollection<E>
-
pick
- Specified by:
pick
in interfaceXProcessingSequence<E>
-
removeSelection
public final long removeSelection(long[] indices)- Specified by:
removeSelection
in interfaceXRemovingSequence<E>
-
removeRange
- Specified by:
removeRange
in interfaceXRemovingSequence<E>
-
retainRange
Description copied from interface:XRemovingSequence
Removing all elements but the ones from the offset (basically start index) to the offset+length (end index).- Specified by:
retainRange
in interfaceXList<E>
- Specified by:
retainRange
in interfaceXRemovingSequence<E>
- Parameters:
startIndex
- is the index of the first element to retainlength
- is the amount of elements to retain- Returns:
- this
-
range
- Specified by:
range
in interfaceXDecreasingList<E>
- Specified by:
range
in interfaceXDecreasingSequence<E>
- Specified by:
range
in interfaceXGettingList<E>
- Specified by:
range
in interfaceXGettingSequence<E>
- Specified by:
range
in interfaceXIncreasingList<E>
- Specified by:
range
in interfaceXIncreasingSequence<E>
- Specified by:
range
in interfaceXList<E>
- Specified by:
range
in interfaceXSettingList<E>
- Specified by:
range
in interfaceXSettingSequence<E>
-
isEmpty
public final boolean isEmpty() -
iterator
-
listIterator
- Specified by:
listIterator
in interfaceXGettingList<E>
-
listIterator
- Specified by:
listIterator
in interfaceXGettingList<E>
- Throws:
IndexBoundsException
-
at
- Specified by:
at
in interfaceXGettingSequence<E>
- Throws:
IndexBoundsException
-
set
- Specified by:
set
in interfaceXSettingSequence<E>
- Throws:
IndexBoundsException
-
setGet
- Specified by:
setGet
in interfaceXSettingSequence<E>
- Throws:
IndexBoundsException
-
size
public final long size()- Specified by:
size
in interfaceSized
- Specified by:
size
in interfaceXGettingCollection<E>
-
toString
-
toArray
Description copied from interface:XGettingCollection
Returns 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:
toArray
in interfaceXGettingCollection<E>
- Returns:
- an array containing all of the elements in this collection
-
clear
public final void clear()Description copied from interface:XRemovingCollection
Clears all elements from the collection while leaving the capacity as it is.- Specified by:
clear
in interfaceClearable
- Specified by:
clear
in interfaceXRemovingCollection<E>
-
equals
Deprecated.Description copied from interface:XGettingCollection
Performs an equality comparison according to the specification inCollection
.Note that it is this interface's author opinion that the whole concept of equals() in standard Java, especially in the collection implementations, is flawed.
The reason is because all different kinds of comparison types that actually depend on the situation have to be mixed up in a harcoded fashion in one method, from identity comparison over data indentity comparison to content comparison.
In order to get the right behavior in every situation, one has to distinct between different types of equality
This means several things:
1.) You can't just say for example an ArrayList is the "same" as a LinkedList just because they contain the same content.
There are different implementations for a good reason, so you have to distinct them when comparing. There are simple code examples which create massive misbehavior that will catastrophically ruin the runtime behavior of a programm due to this error in Java / JDK / Sun / whatever.
2.) You can't always determine equality of two collections by determining equality of each element asCollection
defines it.As a conclusion: don't use this method!
Be clear what type of comparison you really need, then use one of the following methods and proper comparators:
XGettingCollection.equals(XGettingCollection, Equalator)
XGettingCollection.equalsContent(XGettingCollection, Equalator)
- Specified by:
equals
in interfaceXGettingCollection<E>
- Overrides:
equals
in classObject
- Parameters:
o
- the reference object with which to compare.
-
hashCode
Deprecated.- Specified by:
hashCode
in interfaceXGettingCollection<E>
- Overrides:
hashCode
in classObject
-
old
- Specified by:
old
in interfaceXGettingCollection<E>
- Specified by:
old
in interfaceXGettingList<E>
-
collector
- Specified by:
collector
in interfaceXAddingCollection<E>
- Specified by:
collector
in interfaceXCollection<E>
- Specified by:
collector
in interfaceXList<E>
-