Class HashTable.Values
- All Implemented Interfaces:
Iterable<V>
,CapacityCarrying
,ConsolidatableCollection
,ExtendedBag<V>
,ExtendedCollection<V>
,ExtendedList<V>
,ExtendedSequence<V>
,OptimizableCollection
,ReleasingCollection<V>
,Sized
,Truncateable
,Sortable<V>
,XBasicTable.Values<K,V>
,XDecreasingList<V>
,XDecreasingSequence<V>
,XGettingBag<V>
,XGettingCollection<V>
,XGettingList<V>
,XGettingMap.Satellite<K,V>
,XGettingMap.Values<K,V>
,XGettingSequence<V>
,XGettingTable.Satellite<K,V>
,XGettingTable.Values<K,V>
,XIndexIterable<V>
,XIterable<V>
,XJoinable<V>
,XMap.Satellite<K,V>
,XMap.Values<K,V>
,XOrderingSequence<V>
,XProcessingBag<V>
,XProcessingCollection<V>
,XProcessingList<V>
,XProcessingMap.Values<K,V>
,XProcessingSequence<V>
,XRemovingBag<V>
,XRemovingCollection<V>
,XRemovingList<V>
,XRemovingSequence<V>
,XReplacingBag<V>
,XReplacingCollection<V>
,XSettingList<V>
,XSettingSequence<V>
,XSortableSequence<V>
,XTable.Values<K,V>
,Processable<V>
,Clearable
,ComponentType
,Copyable
public final class HashTable.Values extends Object implements XTable.Values<K,V>
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
HashTable.Values.OldValues
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.XDecreasingList
XDecreasingList.Creator<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingBag
XGettingBag.Factory<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingCollection
XGettingCollection.Creator<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.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.XIterable
XIterable.Executor<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XProcessingBag
XProcessingBag.Factory<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.XReplacingBag
XReplacingBag.Factory<E>
-
Constructor Summary
Constructors Constructor Description Values()
-
Method Summary
Modifier and Type Method Description boolean
applies(Predicate<? super V> predicate)
Tests each element of the collection on the given predicate.V
at(long index)
void
clear()
Clears all elements from the collection while leaving the capacity as it is.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(V value)
Checks if the given element is contained in the collection.boolean
containsAll(XGettingCollection<? extends V> values)
boolean
containsId(V value)
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 V> predicate)
XList<V>
copy()
Creates a true copy of this collection which references the same elements as this collection does at the time the method is called.<T extends Consumer<? super V>>
TcopySelection(T target, long... indices)
Iterates through all the elements of the given indices and calls theConsumer.accept(Object)
on the targetConsumer
.<T extends Consumer<? super V>>
TcopyTo(T target)
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection.long
count(V value)
Count how many times this element matches another element in the collection using theEqualator
.long
countBy(Predicate<? super V> predicate)
Count how many matches are found using the given predicate on each element of the collection.<T extends Consumer<? super V>>
Tdistinct(T target)
CallsConsumer.accept(Object)
on the targetConsumer
for all the unique/distinct elements of this collection.<T extends Consumer<? super V>>
Tdistinct(T target, Equalator<? super V> equalator)
CallsConsumer.accept(Object)
on the targetConsumer
for all the unique/distinct elements of this collection.Equalator<? super V>
equality()
boolean
equals(XGettingCollection<? extends V> samples, Equalator<? super V> equalator)
boolean
equalsContent(XGettingCollection<? extends V> samples, Equalator<? super V> equalator)
Returnstrue
if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.<T extends Consumer<? super V>>
Texcept(XGettingCollection<? extends V> other, Equalator<? super V> equalator, T 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).V
fetch()
HashTable.Values
fill(long offset, long length, V value)
Fills all slots from the offset to the offset+length with the given element, regardless of whether or not a slot isnull
.<T extends Consumer<? super V>>
TfilterTo(T target, Predicate<? super V> predicate)
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection which testtrue
on the given predicate.V
first()
Gets first element or throwsIndexOutOfBoundsException
if the collection is empty.V
get()
Gets one element from the collection.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.XImmutableList<V>
immure()
Provides an instance of an immutable collection type with equal behavior and data as this instance.long
indexBy(Predicate<? super V> 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(V value)
<T extends Consumer<? super V>>
Tintersect(XGettingCollection<? extends V> other, Equalator<? super V> equalator, T 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()
Returns true if the current capacity cannot be increased any more.boolean
isSorted(Comparator<? super V> comparator)
Tests if the collection is sorted according to the given comparator.<P extends Consumer<? super V>>
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 V>>
PiterateIndexed(P procedure)
Iterates over elements with theIndexedAcceptor
to use not only the element itself but also its coherent index.Iterator<V>
iterator()
<A> A
join(BiConsumer<? super V,? super A> joiner, A aggregate)
Iterates over all elements of the collections and calls the joiner with each element and the aggregate.V
last()
Gets last element or throwsIndexOutOfBoundsException
if the collection is empty.long
lastIndexBy(Predicate<? super V> 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(V value)
ListIterator<V>
listIterator()
ListIterator<V>
listIterator(long index)
V
max(Comparator<? super V> 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 V> comparator)
V
min(Comparator<? super V> comparator)
long
minIndex(Comparator<? super V> comparator)
<C extends Consumer<? super V>>
CmoveSelection(C target, long... indices)
<C extends Consumer<? super V>>
CmoveTo(C target, Predicate<? super V> predicate)
boolean
nullAllowed()
Defines if null-elements are allowed inside the collection or not.boolean
nullContained()
long
nullRemove()
HashTable.Values.OldValues
old()
long
optimize()
Optimizes internal memory usage by rebuilding the storage to only occupy as much memory as needed to store the currently contained elements in terms of the collection's current memory usage configuration (e.g.HashTable<K,V>
parent()
V
peek()
Gets last element or null if the collection is empty.V
pick()
V
pinch()
V
poll()
Gets first element or null if the collection is empty.V
pop()
<P extends Consumer<? super V>>
Pprocess(P procedure)
SubListProcessor<V>
range(long fromIndex, long toIndex)
long
remainingCapacity()
Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.long
remove(V value)
long
removeAll(XGettingCollection<? extends V> values)
V
removeAt(long index)
long
removeBy(Predicate<? super V> predicate)
long
removeDuplicates()
long
removeDuplicates(Equalator<? super V> equalator)
boolean
removeOne(V element)
HashTable.Values
removeRange(long startIndex, long length)
long
removeSelection(long[] indices)
long
replace(Predicate<? super V> predicate, V substitute)
long
replace(V value, V replacement)
long
replaceAll(XGettingCollection<? extends V> values, V replacement)
boolean
replaceOne(Predicate<? super V> predicate, V substitute)
boolean
replaceOne(V value, V replacement)
Replaces the first element that is equal to the given element with the replacement and then returns true.long
retainAll(XGettingCollection<? extends V> values)
Removing all elements except the ones contained in the given elements-collection.HashTable.Values
retainRange(long startIndex, long length)
Removing all elements but the ones from the offset (basically start index) to the offset+length (end index).V
retrieve(V value)
V
retrieveBy(Predicate<? super V> predicate)
HashTable.Values
reverse()
Reverses the order of its own elements and returns itself.long
scan(Predicate<? super V> predicate)
Iterates through the collection and returns the index of the last element that the passedPredicate
applied to ("scanning").V
search(Predicate<? super V> predicate)
Returns the first contained element matching the passed predicate.V
seek(V 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.HashTable.Values
set(long offset, XGettingSequence<? extends V> values, long valuesOffset, long valuesLength)
boolean
set(long index, V value)
HashTable.Values
set(long offset, V[] src, int srcIndex, int srcLength)
HashTable.Values
setAll(long offset, V... values)
void
setFirst(V value)
V
setGet(long index, V value)
void
setLast(V value)
HashTable.Values
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.HashTable.Values
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.HashTable.Values
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.HashTable.Values
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()
HashTable.Values
sort(Comparator<? super V> comparator)
Sorts this collection according to the given comparator and returns itself.long
substitute(Function<? super V,? extends V> mapper)
long
substitute(Predicate<? super V> predicate, Function<V,V> mapper)
HashTable.Values
swap(long indexA, long indexB)
HashTable.Values
swap(long indexA, long indexB, long length)
Object[]
toArray()
Returns an array containing all of the elements in this collection.V[]
toArray(Class<V> type)
Returns a typed array containing all of the elements in this collection.HashTable.Values
toReversed()
Creates a newXGettingSequence
with the reversed order of elements.String
toString()
void
truncate()
Clears (and reinitializes if needed) this collection in the fastest possible way, i.e.<T extends Consumer<? super V>>
Tunion(XGettingCollection<? extends V> other, Equalator<? super V> equalator, T target)
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection.ListView<V>
view()
Creates a view of this collection and returns it.SubListView<V>
view(long fromIndex, long toIndex)
Creates a sub-view of this collection and returns it.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface one.microstream.collections.types.XGettingCollection
equals, hashCode, intSize
-
Constructor Details
-
Values
public Values()
-
-
Method Details
-
equality
- Specified by:
equality
in interfaceXGettingCollection<V>
-
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 interfaceXBasicTable.Values<K,V>
- Specified by:
copy
in interfaceXDecreasingList<V>
- Specified by:
copy
in interfaceXDecreasingSequence<V>
- Specified by:
copy
in interfaceXGettingBag<V>
- Specified by:
copy
in interfaceXGettingCollection<V>
- Specified by:
copy
in interfaceXGettingList<V>
- Specified by:
copy
in interfaceXGettingSequence<V>
- Specified by:
copy
in interfaceXGettingTable.Values<K,V>
- Specified by:
copy
in interfaceXMap.Values<K,V>
- Specified by:
copy
in interfaceXProcessingBag<V>
- Specified by:
copy
in interfaceXProcessingList<V>
- Specified by:
copy
in interfaceXReplacingBag<V>
- Specified by:
copy
in interfaceXSettingList<V>
- Specified by:
copy
in interfaceXSettingSequence<V>
- Specified by:
copy
in interfaceXSortableSequence<V>
- Specified by:
copy
in interfaceXTable.Values<K,V>
- Returns:
- a copy of this list
-
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)
.- Specified by:
iterate
in interfaceXGettingTable.Values<K,V>
- Specified by:
iterate
in interfaceXIterable<V>
- Specified by:
iterate
in interfaceXProcessingCollection<V>
- Type Parameters:
P
- type of procedure- Parameters:
procedure
- The procedure to be performed for each element- Returns:
- Given procedure
-
join
Description copied from interface:XJoinable
Iterates over all elements of the collections and calls the joiner with each element and the aggregate. -
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<V>
- Type Parameters:
P
- type of procedure- Parameters:
procedure
- which is executed when iterating- Returns:
- Given procedure
-
toReversed
Description copied from interface:XGettingSequence
Creates a newXGettingSequence
with the reversed order of elements.This method creates a new collection and does not change the existing collection.
- Specified by:
toReversed
in interfaceXDecreasingList<V>
- Specified by:
toReversed
in interfaceXDecreasingSequence<V>
- Specified by:
toReversed
in interfaceXGettingList<V>
- Specified by:
toReversed
in interfaceXGettingSequence<V>
- Specified by:
toReversed
in interfaceXProcessingList<V>
- Specified by:
toReversed
in interfaceXProcessingSequence<V>
- Specified by:
toReversed
in interfaceXSettingList<V>
- Specified by:
toReversed
in interfaceXSettingSequence<V>
- Specified by:
toReversed
in interfaceXSortableSequence<V>
- Returns:
- New copy of the collection
-
containsSearched
- Specified by:
containsSearched
in interfaceXGettingCollection<V>
-
applies
Description copied from interface:XGettingCollection
Tests each element of the collection on the given predicate.- Specified by:
applies
in interfaceXGettingCollection<V>
- 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.
-
contains
Description copied from interface:XGettingCollection
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.- Specified by:
contains
in interfaceXGettingCollection<V>
- Parameters:
value
- 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<V>
- Parameters:
values
- to be searched in the collection.- Returns:
- Whether this collection contains all given elements as specified by the
Equalator
.
-
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<V>
- Parameters:
value
- the element to be searched in the collection by identity.- Returns:
- whether this collection contains exactly the given element.
-
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<V>
- 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<V>
- Parameters:
target
- on which theConsumer.accept(Object)
is called for elements that testtrue
.predicate
- on which to test all elements.- Returns:
- Given target
-
count
Description copied from interface:XGettingCollection
Count how many times this element matches another element in the collection using theEqualator
.- Specified by:
count
in interfaceXGettingCollection<V>
- Parameters:
value
- to count- Returns:
- Amount of matches
-
countBy
Description copied from interface:XGettingCollection
Count how many matches are found using the given predicate on each element of the collection.- Specified by:
countBy
in interfaceXGettingCollection<V>
- Parameters:
predicate
- defines which elements are counted and which are not- Returns:
- Amount of matches
-
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<V>
- 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<V>
- 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
-
equals
public final boolean equals(XGettingCollection<? extends V> samples, Equalator<? super V> equalator)- Specified by:
equals
in interfaceXGettingCollection<V>
- 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 V> samples, Equalator<? super V> 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<V>
- 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
-
except
public final <T extends Consumer<? super V>> T except(XGettingCollection<? extends V> other, Equalator<? super V> equalator, T 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<V>
- Type Parameters:
T
- type of the target- Parameters:
other
- 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
-
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<V>
- Specified by:
hasVolatileElements
in interfaceXGettingCollection<V>
- Returns:
true
if the collection contains volatile elements.
-
intersect
public final <T extends Consumer<? super V>> T intersect(XGettingCollection<? extends V> other, Equalator<? super V> equalator, T 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<V>
- Parameters:
other
- 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
-
isEmpty
public final boolean isEmpty() -
iterator
-
max
- Specified by:
max
in interfaceXGettingCollection<V>
-
min
- Specified by:
min
in interfaceXGettingCollection<V>
-
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<V>
- Returns:
true
if null is allowed inside the collection;false
if not
-
nullContained
public final boolean nullContained()- Specified by:
nullContained
in interfaceXGettingCollection<V>
-
old
- Specified by:
old
in interfaceXGettingCollection<V>
- Specified by:
old
in interfaceXGettingList<V>
-
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<V>
- Parameters:
sample
- to seek in the collection- Returns:
- the first contained element matching the passed sample
-
search
Description copied from interface:XGettingCollection
Returns the first contained element matching the passed predicate.- Specified by:
search
in interfaceXGettingCollection<V>
- Parameters:
predicate
- defines which element is searched- Returns:
- Matching element
-
size
public final long size()- Specified by:
size
in interfaceSized
- Specified by:
size
in interfaceXGettingCollection<V>
-
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()Description copied from interface:CapacityCarrying
Returns true if the current capacity cannot be increased any more.- Specified by:
isFull
in interfaceCapacityCarrying
-
remainingCapacity
public final long remainingCapacity()Description copied from interface:CapacityCarrying
Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.- Specified by:
remainingCapacity
in interfaceCapacityCarrying
-
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<V>
- Returns:
- an array containing all of the elements in this 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<V>
- Returns:
- a typed array containing all of the elements in this collection
-
union
public final <T extends Consumer<? super V>> T union(XGettingCollection<? extends V> other, Equalator<? super V> equalator, T 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<V>
- Parameters:
other
- 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
-
parent
- Specified by:
parent
in interfaceXBasicTable.Values<K,V>
- Specified by:
parent
in interfaceXGettingMap.Satellite<K,V>
- Specified by:
parent
in interfaceXGettingTable.Satellite<K,V>
- Specified by:
parent
in interfaceXGettingTable.Values<K,V>
- Specified by:
parent
in interfaceXMap.Satellite<K,V>
- Specified by:
parent
in interfaceXTable.Values<K,V>
-
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<V>
- Specified by:
view
in interfaceXGettingSequence<V>
- Specified by:
view
in interfaceXProcessingSequence<V>
- 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
-
listIterator
- Specified by:
listIterator
in interfaceXGettingList<V>
-
listIterator
- Specified by:
listIterator
in interfaceXGettingList<V>
-
range
- Specified by:
range
in interfaceXDecreasingList<V>
- Specified by:
range
in interfaceXDecreasingSequence<V>
- Specified by:
range
in interfaceXGettingList<V>
- Specified by:
range
in interfaceXGettingSequence<V>
- Specified by:
range
in interfaceXSettingList<V>
- Specified by:
range
in interfaceXSettingSequence<V>
-
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<V>
- Specified by:
immure
in interfaceXGettingCollection<V>
- Specified by:
immure
in interfaceXGettingList<V>
- Specified by:
immure
in interfaceXGettingSequence<V>
- Specified by:
immure
in interfaceXProcessingBag<V>
- Returns:
- an immutable copy of this collection instance.
-
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 interfaceXBasicTable.Values<K,V>
- Specified by:
view
in interfaceXGettingBag<V>
- Specified by:
view
in interfaceXGettingCollection<V>
- Specified by:
view
in interfaceXGettingList<V>
- Specified by:
view
in interfaceXGettingSequence<V>
- Specified by:
view
in interfaceXProcessingBag<V>
- Returns:
- new read-only collection to view this collection
-
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<V>
- Type Parameters:
T
- type of the target- Parameters:
target
- on which theConsumer.accept(Object)
is calledindices
- of the elements which are copied- Returns:
- Given target
-
at
- Specified by:
at
in interfaceXGettingSequence<V>
-
get
Description copied from interface:XGettingCollection
Gets one element from the collection. If the collection is not orderedXGettingSequence
, then it is undefined which element is returned. If the collection is ordered, the element at index 0 is returned.- Specified by:
get
in interfaceXGettingCollection<V>
- Specified by:
get
in interfaceXGettingSequence<V>
- Returns:
- the first / any element.
- See Also:
XGettingSequence.at(long)
,XGettingSequence.first()
,XGettingSequence.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<V>
- Returns:
- First element
-
last
Description copied from interface:XGettingSequence
Gets last element or throwsIndexOutOfBoundsException
if the collection is empty.- Specified by:
last
in interfaceXGettingSequence<V>
- Returns:
- Last element
-
poll
Description copied from interface:XGettingSequence
Gets first element or null if the collection is empty.- Specified by:
poll
in interfaceXGettingSequence<V>
- 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<V>
- Returns:
- Last element or null
-
indexOf
- Specified by:
indexOf
in interfaceXGettingSequence<V>
-
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<V>
- Parameters:
predicate
- to define a valid element- Returns:
- The index of the first positively tested element.
-
isSorted
Description copied from interface:XGettingSequence
Tests if the collection is sorted according to the given comparator.- Specified by:
isSorted
in interfaceXGettingSequence<V>
- Parameters:
comparator
- defines if elements are sorted- Returns:
- true if it sorted, false if not
-
lastIndexOf
- Specified by:
lastIndexOf
in interfaceXGettingSequence<V>
-
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<V>
- Parameters:
predicate
- to define a valid element- Returns:
- the index of the last positively tested element.
-
maxIndex
- Specified by:
maxIndex
in interfaceXGettingSequence<V>
-
minIndex
- Specified by:
minIndex
in interfaceXGettingSequence<V>
-
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<V>
- Parameters:
predicate
- to define a valid element- Returns:
- the index of the last positively tested element.
-
moveSelection
- Specified by:
moveSelection
in interfaceXProcessingSequence<V>
-
removeAt
- Specified by:
removeAt
in interfaceXProcessingSequence<V>
-
fetch
- Specified by:
fetch
in interfaceXProcessingCollection<V>
-
pop
- Specified by:
pop
in interfaceXProcessingSequence<V>
-
pinch
- Specified by:
pinch
in interfaceXProcessingCollection<V>
-
pick
- Specified by:
pick
in interfaceXProcessingSequence<V>
-
retrieve
- Specified by:
retrieve
in interfaceXProcessingCollection<V>
-
retrieveBy
- Specified by:
retrieveBy
in interfaceXProcessingCollection<V>
-
removeOne
- Specified by:
removeOne
in interfaceXRemovingCollection<V>
-
removeRange
- Specified by:
removeRange
in interfaceXRemovingSequence<V>
-
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 interfaceXRemovingSequence<V>
- Parameters:
startIndex
- is the index of the first element to retainlength
- is the amount of elements to retain- Returns:
- this
-
removeSelection
public final long removeSelection(long[] indices)- Specified by:
removeSelection
in interfaceXRemovingSequence<V>
-
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<V>
-
consolidate
public final long consolidate()Description copied from interface:ConsolidatableCollection
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).- Specified by:
consolidate
in interfaceConsolidatableCollection
- Specified by:
consolidate
in interfaceXRemovingCollection<V>
- Returns:
- the number of discarded entries.
-
moveTo
- Specified by:
moveTo
in interfaceXProcessingCollection<V>
-
nullRemove
public final long nullRemove()- Specified by:
nullRemove
in interfaceXRemovingCollection<V>
-
optimize
public final long optimize()Description copied from interface:XRemovingCollection
Optimizes internal memory usage by rebuilding the storage to only occupy as much memory as needed to store the currently contained elements in terms of the collection's current memory usage configuration (e.g. hash density).If this is not possible or not needed in the concreate implementation, this method does nothing.
Note that this method can consume a considerable amount of time depending on the implementation and should only be called intentionally and accurately when reducing occupied memory is needed.
- Specified by:
optimize
in interfaceOptimizableCollection
- Specified by:
optimize
in interfaceXRemovingCollection<V>
- Returns:
- the amount of elements that can be added before the internal storage has to be adjusted.
-
process
- Specified by:
process
in interfaceProcessable<V>
-
removeBy
- Specified by:
removeBy
in interfaceXProcessingCollection<V>
-
remove
- Specified by:
remove
in interfaceXRemovingCollection<V>
-
removeAll
- Specified by:
removeAll
in interfaceXRemovingCollection<V>
-
removeDuplicates
public final long removeDuplicates()- Specified by:
removeDuplicates
in interfaceXRemovingCollection<V>
-
removeDuplicates
- Specified by:
removeDuplicates
in interfaceXProcessingCollection<V>
-
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<V>
- Parameters:
values
- to retain- Returns:
- Amount of deleted elements
-
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<V>
-
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<V>
- Specified by:
fill
in interfaceXSettingList<V>
- Parameters:
offset
- from the start of the collection (start index)length
- of how many slots should be filledvalue
- to use for filling of slots- Returns:
- this
-
replace
- Specified by:
replace
in interfaceXReplacingBag<V>
-
replaceAll
- Specified by:
replaceAll
in interfaceXReplacingBag<V>
-
substitute
- Specified by:
substitute
in interfaceXReplacingCollection<V>
-
substitute
- Specified by:
substitute
in interfaceXReplacingBag<V>
-
replaceOne
Description copied from interface:XReplacingBag
Replaces the first element that is equal to the given element with the replacement and then returns true.- Specified by:
replaceOne
in interfaceXReplacingBag<V>
- Parameters:
value
- to replacereplacement
- for the found element- Returns:
true
if element is found,false
if not
-
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<V>
- Specified by:
reverse
in interfaceXDecreasingSequence<V>
- Specified by:
reverse
in interfaceXOrderingSequence<V>
- Specified by:
reverse
in interfaceXSettingList<V>
- Specified by:
reverse
in interfaceXSettingSequence<V>
- Specified by:
reverse
in interfaceXSortableSequence<V>
- Returns:
- this
-
set
- Specified by:
set
in interfaceXSettingSequence<V>
-
setGet
- Specified by:
setGet
in interfaceXSettingSequence<V>
-
setAll
- Specified by:
setAll
in interfaceXDecreasingList<V>
- Specified by:
setAll
in interfaceXDecreasingSequence<V>
- Specified by:
setAll
in interfaceXSettingList<V>
- Specified by:
setAll
in interfaceXSettingSequence<V>
-
set
- Specified by:
set
in interfaceXDecreasingList<V>
- Specified by:
set
in interfaceXDecreasingSequence<V>
- Specified by:
set
in interfaceXSettingList<V>
- Specified by:
set
in interfaceXSettingSequence<V>
-
set
public final HashTable.Values set(long offset, XGettingSequence<? extends V> values, long valuesOffset, long valuesLength)- Specified by:
set
in interfaceXDecreasingList<V>
- Specified by:
set
in interfaceXDecreasingSequence<V>
- Specified by:
set
in interfaceXSettingList<V>
- Specified by:
set
in interfaceXSettingSequence<V>
-
setFirst
- Specified by:
setFirst
in interfaceXSettingSequence<V>
-
setLast
- Specified by:
setLast
in interfaceXSettingSequence<V>
-
sort
Description copied from interface:Sortable
Sorts this collection according to the given comparator and returns itself.- Specified by:
sort
in interfaceSortable<V>
- Specified by:
sort
in interfaceXDecreasingList<V>
- Specified by:
sort
in interfaceXDecreasingSequence<V>
- Specified by:
sort
in interfaceXSettingList<V>
- Specified by:
sort
in interfaceXSettingSequence<V>
- Specified by:
sort
in interfaceXSortableSequence<V>
- Parameters:
comparator
- to sort this collection- Returns:
- this
-
replace
- Specified by:
replace
in interfaceXReplacingBag<V>
-
replaceOne
- Specified by:
replaceOne
in interfaceXReplacingBag<V>
-
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 interfaceXOrderingSequence<V>
- Specified by:
shiftTo
in interfaceXSortableSequence<V>
- 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 interfaceXOrderingSequence<V>
- Specified by:
shiftTo
in interfaceXSortableSequence<V>
- 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 interfaceXOrderingSequence<V>
- Specified by:
shiftBy
in interfaceXSortableSequence<V>
- 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 interfaceXOrderingSequence<V>
- Specified by:
shiftBy
in interfaceXSortableSequence<V>
- 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
- Specified by:
swap
in interfaceXDecreasingList<V>
- Specified by:
swap
in interfaceXDecreasingSequence<V>
- Specified by:
swap
in interfaceXOrderingSequence<V>
- Specified by:
swap
in interfaceXSettingList<V>
- Specified by:
swap
in interfaceXSettingSequence<V>
- Specified by:
swap
in interfaceXSortableSequence<V>
-
swap
- Specified by:
swap
in interfaceXDecreasingList<V>
- Specified by:
swap
in interfaceXDecreasingSequence<V>
- Specified by:
swap
in interfaceXOrderingSequence<V>
- Specified by:
swap
in interfaceXSettingList<V>
- Specified by:
swap
in interfaceXSettingSequence<V>
- Specified by:
swap
in interfaceXSortableSequence<V>
-