Class HashTable<K,V>
- Type Parameters:
K
- type of contained keysV
- type of contained values
- All Implemented Interfaces:
Iterable<KeyValue<K,V>>
,Consumer<KeyValue<K,V>>
,CapacityCarrying
,CapacityExtendable
,ConsolidatableCollection
,ExtendedCollection<KeyValue<K,V>>
,ExtendedMap<K,V>
,ExtendedSequence<KeyValue<K,V>>
,HashCollection<K>
,OptimizableCollection
,ReleasingCollection<KeyValue<K,V>>
,Sized
,Truncateable
,Sortable<KeyValue<K,V>>
,SortableProcedure<KeyValue<K,V>>
,XAddGetCollection<KeyValue<K,V>>
,XAddGetMap<K,V>
,XAddGetSet<KeyValue<K,V>>
,XAddingCollection<KeyValue<K,V>>
,XAddingEnum<KeyValue<K,V>>
,XAddingMap<K,V>
,XAddingSequence<KeyValue<K,V>>
,XAddingSet<KeyValue<K,V>>
,XAddingTable<K,V>
,XBasicEnum<KeyValue<K,V>>
,XBasicSequence<KeyValue<K,V>>
,XBasicTable<K,V>
,XCollection<KeyValue<K,V>>
,XDecreasingEnum<KeyValue<K,V>>
,XDecreasingSequence<KeyValue<K,V>>
,XEnum<KeyValue<K,V>>
,XExpandingEnum<KeyValue<K,V>>
,XExpandingSequence<KeyValue<K,V>>
,XExtendingEnum<KeyValue<K,V>>
,XExtendingSequence<KeyValue<K,V>>
,XGettingCollection<KeyValue<K,V>>
,XGettingEnum<KeyValue<K,V>>
,XGettingMap<K,V>
,XGettingSequence<KeyValue<K,V>>
,XGettingSet<KeyValue<K,V>>
,XGettingTable<K,V>
,XIncreasingEnum<KeyValue<K,V>>
,XIncreasingSequence<KeyValue<K,V>>
,XIndexIterable<KeyValue<K,V>>
,XInputtingEnum<KeyValue<K,V>>
,XInputtingSequence<KeyValue<K,V>>
,XInsertingEnum<KeyValue<K,V>>
,XInsertingSequence<KeyValue<K,V>>
,XIterable<KeyValue<K,V>>
,XJoinable<KeyValue<K,V>>
,XMap<K,V>
,XOrderingEnum<KeyValue<K,V>>
,XOrderingSequence<KeyValue<K,V>>
,XPrependingEnum<KeyValue<K,V>>
,XPrependingSequence<KeyValue<K,V>>
,XPreputtingEnum<KeyValue<K,V>>
,XPreputtingSequence<KeyValue<K,V>>
,XProcessingCollection<KeyValue<K,V>>
,XProcessingEnum<KeyValue<K,V>>
,XProcessingMap<K,V>
,XProcessingSequence<KeyValue<K,V>>
,XProcessingSet<KeyValue<K,V>>
,XPutGetCollection<KeyValue<K,V>>
,XPutGetEnum<KeyValue<K,V>>
,XPutGetMap<K,V>
,XPutGetSequence<KeyValue<K,V>>
,XPutGetSet<KeyValue<K,V>>
,XPuttingCollection<KeyValue<K,V>>
,XPuttingEnum<KeyValue<K,V>>
,XPuttingMap<K,V>
,XPuttingSequence<KeyValue<K,V>>
,XPuttingSet<KeyValue<K,V>>
,XRemovingCollection<KeyValue<K,V>>
,XRemovingEnum<KeyValue<K,V>>
,XRemovingMap<K,V>
,XRemovingSequence<KeyValue<K,V>>
,XRemovingSet<KeyValue<K,V>>
,XReplacingCollection<KeyValue<K,V>>
,XSequence<KeyValue<K,V>>
,XSet<KeyValue<K,V>>
,XSettingEnum<KeyValue<K,V>>
,XSettingSequence<KeyValue<K,V>>
,XSortableEnum<KeyValue<K,V>>
,XSortableSequence<KeyValue<K,V>>
,XTable<K,V>
,IdentityEqualityLogic
,Processable<KeyValue<K,V>>
,Clearable
,Composition
,Copyable
public final class HashTable<K,V> extends AbstractChainKeyValueCollection<K,V,one.microstream.collections.ChainMapEntryLinkedStrongStrong<K,V>> implements XTable<K,V>, HashCollection<K>, Composition, IdentityEqualityLogic
Map
.
In contrast to EqHashTable
this implementation uses the default isSame-Equalator(Equalator.identity()
and the Java hashCode implementation System.identityHashCode(Object)
.
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 SynchSet
wrapper class to use a list in a synchronized manner.
Also note that by being an extended collection, this implementation offers various functional and batch procedures
to maximize internal iteration potential, eliminating the need to use the ill-conceived external iteration
Iterator
paradigm.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
HashTable.Creator<K,V>
class
HashTable.Keys
class
HashTable.OldVarMap
class
HashTable.Values
Nested classes/interfaces inherited from interface one.microstream.collections.interfaces.HashCollection
HashCollection.Analysis<H>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XBasicSequence
XBasicSequence.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.XIncreasingEnum
XIncreasingEnum.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.XProcessingSequence
XProcessingSequence.Factory<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XProcessingSet
XProcessingSet.Factory<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XPutGetSequence
XPutGetSequence.Factory<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XPutGetSet
XPutGetSet.Factory<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XRemovingEnum
XRemovingEnum.Factory<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XRemovingMap
XRemovingMap.Factory<K,V>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XSet
XSet.Factory<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XTable
XTable.Bridge<K,V>, XTable.EntriesBridge<K,V>, XTable.Satellite<K,V>
-
Field Summary
Fields inherited from interface one.microstream.collections.interfaces.HashCollection
DEFAULT_HASH_FACTOR, DEFAULT_HASH_LENGTH
-
Method Summary
Modifier and Type Method Description void
accept(KeyValue<K,V> entry)
boolean
add(K key, V value)
Adds the passed key and value as an entry if key is not yet contained.boolean
add(KeyValue<K,V> entry)
Adds the passed element.HashTable<K,V>
addAll(XGettingCollection<? extends KeyValue<K,V>> elements)
HashTable<K,V>
addAll(KeyValue<K,V>... elements)
HashTable<K,V>
addAll(KeyValue<K,V>[] elements, int srcIndex, int srcLength)
KeyValue<K,V>
addGet(K key, V value)
KeyValue<K,V>
addGet(KeyValue<K,V> entry)
HashCollection.Analysis<HashTable<K,V>>
analyze()
boolean
applies(Predicate<? super KeyValue<K,V>> predicate)
Tests each element of the collection on the given predicate.KeyValue<K,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(KeyValue<K,V> entry)
Checks if the given element is contained in the collection.boolean
containsAll(XGettingCollection<? extends KeyValue<K,V>> elements)
boolean
containsId(KeyValue<K,V> entry)
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 KeyValue<K,V>> predicate)
HashTable<K,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 KeyValue<K, V>>>
TcopySelection(T target, long... indices)
Iterates through all the elements of the given indices and calls theConsumer.accept(Object)
on the targetConsumer
.<C extends Consumer<? super KeyValue<K, V>>>
CcopyTo(C target)
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection.long
count(KeyValue<K,V> entry)
Count how many times this element matches another element in the collection using theEqualator
.long
countBy(Predicate<? super KeyValue<K,V>> 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.KeyValue<K,V>
deduplicate(KeyValue<K,V> entry)
<C extends Consumer<? super KeyValue<K, V>>>
Cdistinct(C target)
CallsConsumer.accept(Object)
on the targetConsumer
for all the unique/distinct elements of this collection.<C extends Consumer<? super KeyValue<K, V>>>
Cdistinct(C target, Equalator<? super KeyValue<K,V>> equalator)
CallsConsumer.accept(Object)
on the targetConsumer
for all the unique/distinct elements of this collection.V
ensure(K key, Function<? super K,V> valueProvider)
Ensures that this map instance contains a non-null value for the passed key and returns that value.CapacityExtendable
ensureCapacity(long minimalCapacity)
CapacityExtendable
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.HashEqualator<KeyValue<K,V>>
equality()
boolean
equals(XGettingCollection<? extends KeyValue<K,V>> samples, Equalator<? super KeyValue<K,V>> equalator)
boolean
equalsContent(XGettingCollection<? extends KeyValue<K,V>> samples, Equalator<? super KeyValue<K,V>> 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 KeyValue<K, V>>>
Cexcept(XGettingCollection<? extends KeyValue<K,V>> other, Equalator<? super KeyValue<K,V>> 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).KeyValue<K,V>
fetch()
<C extends Consumer<? super KeyValue<K, V>>>
CfilterTo(C target, Predicate<? super KeyValue<K,V>> predicate)
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection which testtrue
on the given predicate.KeyValue<K,V>
first()
Gets first element or throwsIndexOutOfBoundsException
if the collection is empty.KeyValue<K,V>
get()
Gets one element from the collection.V
get(K key)
protected AbstractChainKeyValueStorage<K,V,one.microstream.collections.ChainMapEntryLinkedStrongStrong<K,V>>
getInternalStorageChain()
float
hashDensity()
int
hashDistributionRange()
HashEqualator<K>
hashEquality()
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.boolean
hasVolatileHashElements()
boolean
hasVolatileValues()
ConstHashTable<K,V>
immure()
Provides an instance of an immutable collection type with equal behavior and data as this instance.long
indexBy(Predicate<? super KeyValue<K,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(KeyValue<K,V> entry)
boolean
input(long index, KeyValue<K,V> element)
long
inputAll(long index, XGettingCollection<? extends KeyValue<K,V>> elements)
long
inputAll(long index, KeyValue<K,V>... elements)
long
inputAll(long index, KeyValue<K,V>[] elements, int offset, int length)
boolean
insert(long index, KeyValue<K,V> element)
long
insertAll(long index, XGettingCollection<? extends KeyValue<K,V>> elements)
long
insertAll(long index, KeyValue<K,V>... elements)
long
insertAll(long index, KeyValue<K,V>[] elements, int offset, int length)
protected int
internalClear()
protected int
internalCountingAddAll(XGettingCollection<? extends KeyValue<K,V>> elements)
protected int
internalCountingAddAll(KeyValue<K,V>[] elements)
protected int
internalCountingAddAll(KeyValue<K,V>[] elements, int offset, int length)
protected int
internalCountingPutAll(XGettingCollection<? extends KeyValue<K,V>> elements)
protected int
internalCountingPutAll(KeyValue<K,V>[] elements)
protected int
internalCountingPutAll(KeyValue<K,V>[] elements, int offset, int length)
protected void
internalRemoveEntry(one.microstream.collections.ChainMapEntryLinkedStrongStrong<K,V> entry)
protected int
internalRemoveNullEntries()
<C extends Consumer<? super KeyValue<K, V>>>
Cintersect(XGettingCollection<? extends KeyValue<K,V>> other, Equalator<? super KeyValue<K,V>> 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()
Returns true if the current capacity cannot be increased any more.boolean
isSorted(Comparator<? super KeyValue<K,V>> comparator)
Tests if the collection is sorted according to the given comparator.<P extends Consumer<? super KeyValue<K, 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 KeyValue<K, V>>>
PiterateIndexed(P procedure)
Iterates over elements with theIndexedAcceptor
to use not only the element itself but also its coherent index.Iterator<KeyValue<K,V>>
iterator()
<A> A
join(BiConsumer<? super KeyValue<K,V>,? super A> joiner, A aggregate)
Iterates over all elements of the collections and calls the joiner with each element and the aggregate.HashTable.Keys
keys()
KeyValue<K,V>
last()
Gets last element or throwsIndexOutOfBoundsException
if the collection is empty.long
lastIndexBy(Predicate<? super KeyValue<K,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(KeyValue<K,V> entry)
KeyValue<K,V>
lookup(K key)
KeyValue<K,V>
max(Comparator<? super KeyValue<K,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 KeyValue<K,V>> comparator)
KeyValue<K,V>
min(Comparator<? super KeyValue<K,V>> comparator)
long
minIndex(Comparator<? super KeyValue<K,V>> comparator)
<C extends Consumer<? super KeyValue<K, V>>>
CmoveSelection(C target, long... indices)
<C extends Consumer<? super KeyValue<K, V>>>
CmoveTo(C target, Predicate<? super KeyValue<K,V>> predicate)
static <K, V> HashTable<K,V>
New()
static <K, V> HashTable<K,V>
New(XGettingCollection<? extends KeyValue<? extends K,? extends V>> entries)
static <K, V> HashTable<K,V>
New(KeyValue<? extends K,? extends V>... entries)
static <K, V> HashTable<K,V>
NewCustom(float hashDensity)
static <K, V> HashTable<K,V>
NewCustom(int initialHashLength)
static <K, V> HashTable<K,V>
NewCustom(int initialHashLength, float hashDensity)
static <K, V> HashTable<K,V>
NewCustom(int initialHashLength, float hashDensity, XGettingCollection<? extends KeyValue<? extends K,? extends V>> entries)
static <K, V> HashTable<K,V>
NewCustom(long desiredCapacity, float hashDensity, KeyValue<? extends K,? extends V>... entries)
static <KI, VI, KO, VO>
HashTable<KO,VO>NewProjected(float hashDensity, XGettingCollection<? extends KeyValue<KI,VI>> entries, Function<? super KI,KO> keyProjector, Function<? super VI,VO> valueProjector)
static <KO, VO, KI extends KO, VI extends VO>
HashTable<KO,VO>NewProjected(XGettingCollection<? extends KeyValue<KI,VI>> entries)
static <KI, VI, KO, VO>
HashTable<KO,VO>NewProjected(XGettingCollection<? extends KeyValue<KI,VI>> entries, Function<? super KI,KO> keyProjector, Function<? super VI,VO> valueProjector)
static <K, V> HashTable<K,V>
NewSingle(K key, V value)
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
nullKeyAllowed()
boolean
nullPrepend()
boolean
nullPreput()
boolean
nullPut()
long
nullRemove()
boolean
nullValuesAllowed()
XTable.EntriesBridge<K,V>
old()
XTable.Bridge<K,V>
oldMap()
long
optimize()
Optimizes the internal storage of this collection and returns the storage size of the collection after the process is complete.KeyValue<K,V>
peek()
Gets last element or null if the collection is empty.KeyValue<K,V>
pick()
KeyValue<K,V>
pinch()
KeyValue<K,V>
poll()
Gets first element or null if the collection is empty.KeyValue<K,V>
pop()
Predicate<KeyValue<K,V>>
predicateContainsEntry()
boolean
prepend(KeyValue<K,V> element)
HashTable<K,V>
prependAll(XGettingCollection<? extends KeyValue<K,V>> elements)
HashTable<K,V>
prependAll(KeyValue<K,V>... elements)
HashTable<K,V>
prependAll(KeyValue<K,V>[] elements, int srcStartIndex, int srcLength)
boolean
preput(KeyValue<K,V> element)
HashTable<K,V>
preputAll(XGettingCollection<? extends KeyValue<K,V>> elements)
HashTable<K,V>
preputAll(KeyValue<K,V>... elements)
HashTable<K,V>
preputAll(KeyValue<K,V>[] elements, int offset, int length)
<P extends Consumer<? super KeyValue<K, V>>>
Pprocess(P procedure)
boolean
put(K key, V value)
Ensures the passed key and value to be contained as an entry in the map.boolean
put(KeyValue<K,V> entry)
Adds the specified element to this collection if it is not already present (optional operation).HashTable<K,V>
putAll(XGettingCollection<? extends KeyValue<K,V>> elements)
Adds the specified elements to this collection if it is not already present (optional operation).HashTable<K,V>
putAll(KeyValue<K,V>... elements)
Ensures the passed key-value-pairs to be contained as entries in the map.HashTable<K,V>
putAll(KeyValue<K,V>[] elements, int srcIndex, int srcLength)
Ensures the passed key-value-pairs to be contained as entries in the map.KeyValue<K,V>
putGet(K key, V value)
Ensures the passed key and value to be contained as an entry in the map.KeyValue<K,V>
putGet(KeyValue<K,V> entry)
<C extends Consumer<? super V>>
Cquery(XIterable<? extends K> keys, C collector)
XEnum<KeyValue<K,V>>
range(long lowIndex, long highIndex)
int
rehash()
Recalculates the hash value of all entries and reorginazes and optimizes the hash storage accordingly.long
remove(KeyValue<K,V> entry)
long
removeAll(XGettingCollection<? extends KeyValue<K,V>> elements)
KeyValue<K,V>
removeAt(long index)
long
removeBy(Predicate<? super KeyValue<K,V>> predicate)
long
removeDuplicates()
long
removeDuplicates(Equalator<? super KeyValue<K,V>> equalator)
V
removeFor(K key)
boolean
removeOne(KeyValue<K,V> entry)
HashTable<K,V>
removeRange(long startIndex, long length)
long
removeSelection(long[] indices)
KeyValue<K,V>
replace(K key, V value)
KeyValue<K,V>
replace(KeyValue<K,V> entry)
long
retainAll(XGettingCollection<? extends KeyValue<K,V>> elements)
Removing all elements except the ones contained in the given elements-collection.HashTable<K,V>
retainRange(long startIndex, long length)
Removing all elements but the ones from the offset (basically start index) to the offset+length (end index).KeyValue<K,V>
retrieve(KeyValue<K,V> entry)
KeyValue<K,V>
retrieveBy(Predicate<? super KeyValue<K,V>> predicate)
HashTable<K,V>
reverse()
Reverses the order of its own elements and returns itself.long
scan(Predicate<? super KeyValue<K,V>> predicate)
Iterates through the collection and returns the index of the last element that the passedPredicate
applied to ("scanning").KeyValue<K,V>
search(Predicate<? super KeyValue<K,V>> predicate)
Returns the first contained element matching the passed predicate.V
searchValue(Predicate<? super K> keyPredicate)
KeyValue<K,V>
seek(KeyValue<K,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<K,V>
set(long index, XGettingSequence<? extends KeyValue<K,V>> elements, long offset, long length)
boolean
set(long index, KeyValue<K,V> element)
HashTable<K,V>
set(long index, KeyValue<K,V>[] elements, int offset, int length)
boolean
set(K key, V value)
Sets the passed key and value to an appropriate entry if one can be found.HashTable<K,V>
setAll(long index, KeyValue<K,V>... elements)
void
setFirst(KeyValue<K,V> element)
KeyValue<K,V>
setGet(long index, KeyValue<K,V> element)
KeyValue<K,V>
setGet(K key, V value)
Sets the passed key and value to an appropriate entry if one can be found.void
setHashDensity(float hashDensity)
Sets the hash density (1/density) of this hashing collection if applicable.void
setLast(KeyValue<K,V> element)
HashTable<K,V>
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<K,V>
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<K,V>
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<K,V>
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<K,V>
sort(Comparator<? super KeyValue<K,V>> comparator)
Sorts this collection according to the given comparator and returns itself.long
substitute(Function<? super KeyValue<K,V>,? extends KeyValue<K,V>> mapper)
KeyValue<K,V>
substitute(K key, V value)
static <K, VK, VV> Function<K,HashTable<VK,VV>>
supplier()
HashTable<K,V>
swap(long indexA, long indexB)
HashTable<K,V>
swap(long indexA, long indexB, long length)
Object[]
toArray()
Returns an array containing all of the elements in this collection.KeyValue<K,V>[]
toArray(Class<KeyValue<K,V>> type)
Returns a typed array containing all of the elements in this collection.HashTable<K,V>
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.<C extends Consumer<? super KeyValue<K, V>>>
Cunion(XGettingCollection<? extends KeyValue<K,V>> other, Equalator<? super KeyValue<K,V>> equalator, C target)
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection.boolean
valuePut(K key, V value)
Ensures the passed value to be either set to an existing entry equal to sampleKey or inserted as a new one.V
valuePutGet(K key, V value)
Ensures the passed value to be either set to an existing entry appropriate to sampleKey or inserted as a new one.HashTable.Values
values()
boolean
valueSet(K key, V value)
Sets only the passed value to an existing entry appropriate to the passed sampleKey.V
valueSetGet(K key, V value)
Sets only the passed value to an existing entry appropriate to the passed sampleKey.XGettingTable<K,V>
view()
Creates a view of this collection and returns it.XGettingEnum<KeyValue<K,V>>
view(long lowIndex, long highIndex)
Creates a sub-view of this collection and returns it.Methods inherited from class one.microstream.collections.AbstractExtendedCollection
ensureFreeArrayCapacity, validateIndex
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, 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
Methods inherited from interface one.microstream.collections.types.XGettingCollection
equals, hashCode, intSize
-
Method Details
-
New
-
NewCustom
-
NewCustom
-
NewCustom
-
New
public static final <K, V> HashTable<K,V> New(XGettingCollection<? extends KeyValue<? extends K,? extends V>> entries) -
NewCustom
public static final <K, V> HashTable<K,V> NewCustom(int initialHashLength, float hashDensity, XGettingCollection<? extends KeyValue<? extends K,? extends V>> entries) -
NewSingle
-
New
@SafeVarargs public static final <K, V> HashTable<K,V> New(KeyValue<? extends K,? extends V>... entries) -
NewCustom
@SafeVarargs public static final <K, V> HashTable<K,V> NewCustom(long desiredCapacity, float hashDensity, KeyValue<? extends K,? extends V>... entries) -
supplier
-
NewProjected
public static final <KI, VI, KO, VO> HashTable<KO,VO> NewProjected(float hashDensity, XGettingCollection<? extends KeyValue<KI,VI>> entries, Function<? super KI,KO> keyProjector, Function<? super VI,VO> valueProjector) -
NewProjected
public static final <KO, VO, KI extends KO, VI extends VO> HashTable<KO,VO> NewProjected(XGettingCollection<? extends KeyValue<KI,VI>> entries) -
NewProjected
public static final <KI, VI, KO, VO> HashTable<KO,VO> NewProjected(XGettingCollection<? extends KeyValue<KI,VI>> entries, Function<? super KI,KO> keyProjector, Function<? super VI,VO> valueProjector) -
lookup
- Specified by:
lookup
in interfaceXGettingMap<K,V>
-
internalCountingAddAll
protected int internalCountingAddAll(KeyValue<K,V>[] elements) throws UnsupportedOperationException- Specified by:
internalCountingAddAll
in classAbstractExtendedCollection<KeyValue<K,V>>
- Throws:
UnsupportedOperationException
-
internalCountingAddAll
protected int internalCountingAddAll(KeyValue<K,V>[] elements, int offset, int length) throws UnsupportedOperationException- Specified by:
internalCountingAddAll
in classAbstractExtendedCollection<KeyValue<K,V>>
- Throws:
UnsupportedOperationException
-
internalCountingAddAll
protected int internalCountingAddAll(XGettingCollection<? extends KeyValue<K,V>> elements) throws UnsupportedOperationException- Specified by:
internalCountingAddAll
in classAbstractExtendedCollection<KeyValue<K,V>>
- Throws:
UnsupportedOperationException
-
internalCountingPutAll
protected int internalCountingPutAll(KeyValue<K,V>[] elements) throws UnsupportedOperationException- Specified by:
internalCountingPutAll
in classAbstractExtendedCollection<KeyValue<K,V>>
- Throws:
UnsupportedOperationException
-
internalCountingPutAll
protected int internalCountingPutAll(KeyValue<K,V>[] elements, int offset, int length) throws UnsupportedOperationException- Specified by:
internalCountingPutAll
in classAbstractExtendedCollection<KeyValue<K,V>>
- Throws:
UnsupportedOperationException
-
internalCountingPutAll
protected int internalCountingPutAll(XGettingCollection<? extends KeyValue<K,V>> elements) throws UnsupportedOperationException- Specified by:
internalCountingPutAll
in classAbstractExtendedCollection<KeyValue<K,V>>
- Throws:
UnsupportedOperationException
-
internalRemoveNullEntries
protected int internalRemoveNullEntries()- Specified by:
internalRemoveNullEntries
in classAbstractChainKeyValueCollection<K,V,one.microstream.collections.ChainMapEntryLinkedStrongStrong<K,V>>
-
internalRemoveEntry
protected void internalRemoveEntry(one.microstream.collections.ChainMapEntryLinkedStrongStrong<K,V> entry)- Specified by:
internalRemoveEntry
in classAbstractChainKeyValueCollection<K,V,one.microstream.collections.ChainMapEntryLinkedStrongStrong<K,V>>
-
internalClear
protected int internalClear()- Specified by:
internalClear
in classAbstractChainKeyValueCollection<K,V,one.microstream.collections.ChainMapEntryLinkedStrongStrong<K,V>>
-
getInternalStorageChain
protected AbstractChainKeyValueStorage<K,V,one.microstream.collections.ChainMapEntryLinkedStrongStrong<K,V>> getInternalStorageChain()- Specified by:
getInternalStorageChain
in classAbstractChainCollection<KeyValue<K,V>,K,V,one.microstream.collections.ChainMapEntryLinkedStrongStrong<K,V>>
-
size
public final long size()- Specified by:
size
in interfaceHashCollection<K>
- Specified by:
size
in interfaceSized
- Specified by:
size
in interfaceXGettingCollection<K>
- Specified by:
size
in classAbstractChainKeyValueCollection<K,V,one.microstream.collections.ChainMapEntryLinkedStrongStrong<K,V>>
-
rehash
public final int rehash()Description copied from interface:HashCollection
Recalculates the hash value of all entries and reorginazes and optimizes the hash storage accordingly. This method is meant for cases where a hash collection has to collect its elements before proper hash values can be derived for them or where hash mutable elements can change their hash-relevant state after having been added (and hashed) in a hash collection. Note that depending on the hash-relevant state of elements and their changing of it, it can be possible that some elements oust others, thus decreasing the collection's size. This behavior depends on the type of the elements and the used hash logic and cannot be compensated by a general purpose collection implementation.- Specified by:
rehash
in interfaceHashCollection<K>
- Returns:
- the new size of the collection which might be lower than before the call.
-
isEmpty
public final boolean isEmpty() -
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<K>
-
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<K>
-
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
HashTable
this removes all empty entries from the passed chain and returns the number of removed entries.- Specified by:
consolidate
in interfaceConsolidatableCollection
- Specified by:
consolidate
in interfaceXRemovingCollection<K>
- Returns:
- the number of discarded entries.
-
ensureCapacity
- Specified by:
ensureCapacity
in interfaceCapacityExtendable
-
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
-
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<K>
- Returns:
- the storage size of the collection after the optimzation.
-
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<K>
- Specified by:
copy
in interfaceXAddGetSet<K>
- Specified by:
copy
in interfaceXBasicEnum<K>
- Specified by:
copy
in interfaceXBasicSequence<K>
- Specified by:
copy
in interfaceXBasicTable<K,V>
- Specified by:
copy
in interfaceXCollection<K>
- Specified by:
copy
in interfaceXDecreasingEnum<K>
- Specified by:
copy
in interfaceXDecreasingSequence<K>
- Specified by:
copy
in interfaceXEnum<K>
- Specified by:
copy
in interfaceXGettingCollection<K>
- Specified by:
copy
in interfaceXGettingEnum<K>
- Specified by:
copy
in interfaceXGettingMap<K,V>
- Specified by:
copy
in interfaceXGettingSequence<K>
- Specified by:
copy
in interfaceXGettingSet<K>
- Specified by:
copy
in interfaceXGettingTable<K,V>
- Specified by:
copy
in interfaceXIncreasingEnum<K>
- Specified by:
copy
in interfaceXIncreasingSequence<K>
- Specified by:
copy
in interfaceXMap<K,V>
- Specified by:
copy
in interfaceXProcessingEnum<K>
- Specified by:
copy
in interfaceXProcessingMap<K,V>
- Specified by:
copy
in interfaceXProcessingSet<K>
- Specified by:
copy
in interfaceXPutGetCollection<K>
- Specified by:
copy
in interfaceXPutGetEnum<K>
- Specified by:
copy
in interfaceXPutGetSequence<K>
- Specified by:
copy
in interfaceXPutGetSet<K>
- Specified by:
copy
in interfaceXSequence<K>
- Specified by:
copy
in interfaceXSet<K>
- Specified by:
copy
in interfaceXSettingEnum<K>
- Specified by:
copy
in interfaceXSettingSequence<K>
- Specified by:
copy
in interfaceXSortableEnum<K>
- Specified by:
copy
in interfaceXSortableSequence<K>
- Specified by:
copy
in interfaceXTable<K,V>
- Returns:
- a copy of this list
-
immure
Description copied from interface:XGettingMap
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 interfaceXBasicEnum<K>
- Specified by:
immure
in interfaceXGettingCollection<K>
- Specified by:
immure
in interfaceXGettingEnum<K>
- Specified by:
immure
in interfaceXGettingMap<K,V>
- Specified by:
immure
in interfaceXGettingSequence<K>
- Specified by:
immure
in interfaceXGettingSet<K>
- Specified by:
immure
in interfaceXGettingTable<K,V>
- Specified by:
immure
in interfaceXMap<K,V>
- Specified by:
immure
in interfaceXProcessingSet<K>
- 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 interfaceXGettingCollection<K>
- Specified by:
view
in interfaceXGettingEnum<K>
- Specified by:
view
in interfaceXGettingMap<K,V>
- Specified by:
view
in interfaceXGettingSequence<K>
- Specified by:
view
in interfaceXGettingTable<K,V>
- Returns:
- new read-only collection to view this collection
-
setHashDensity
public final void setHashDensity(float hashDensity)Description copied from interface:HashCollection
Sets the hash density (1/density) of this hashing collection if applicable.If this procedure is not applicable for the hash collection (e.g. an immutable hash collection), calling this method has no effect.
- Specified by:
setHashDensity
in interfaceHashCollection<K>
- Parameters:
hashDensity
- the new hash density to be set.
-
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<K>
- Specified by:
hasVolatileElements
in interfaceXGettingCollection<K>
- 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<K>
- Returns:
true
if null is allowed inside the collection;false
if not
-
nullKeyAllowed
public final boolean nullKeyAllowed()- Specified by:
nullKeyAllowed
in interfaceXAddingMap<K,V>
- Specified by:
nullKeyAllowed
in interfaceXGettingMap<K,V>
- Specified by:
nullKeyAllowed
in interfaceXMap<K,V>
-
nullValuesAllowed
public final boolean nullValuesAllowed()- Specified by:
nullValuesAllowed
in interfaceXAddingMap<K,V>
- Specified by:
nullValuesAllowed
in interfaceXGettingMap<K,V>
- Specified by:
nullValuesAllowed
in interfaceXMap<K,V>
-
get
-
ensure
Description copied from interface:XAddGetMap
Ensures that this map instance contains a non-null value for the passed key and returns that value.If a non-null value can be found for the passed key, it is returned. Otherwise, the value provided by the passed supplier will be associated with the passed key and is returned.
- Specified by:
ensure
in interfaceXAddGetMap<K,V>
- Parameters:
key
- the search key.valueProvider
- the value supplier used to provide a value for the passed key in case non could be found.- Returns:
- the value associated with the passed key, either already existing or newly assiciated by the call of this method.
-
keys
-
old
-
oldMap
-
searchValue
- Specified by:
searchValue
in interfaceXGettingMap<K,V>
- Specified by:
searchValue
in interfaceXMap<K,V>
-
query
- Specified by:
query
in interfaceXGettingMap<K,V>
-
values
- Specified by:
values
in interfaceXBasicTable<K,V>
- Specified by:
values
in interfaceXGettingMap<K,V>
- Specified by:
values
in interfaceXGettingTable<K,V>
- Specified by:
values
in interfaceXMap<K,V>
- Specified by:
values
in interfaceXProcessingMap<K,V>
- Specified by:
values
in interfaceXTable<K,V>
-
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()Description copied from interface:CapacityCarrying
Returns true if the current capacity cannot be increased any more.- Specified by:
isFull
in interfaceCapacityCarrying
-
hasVolatileValues
public final boolean hasVolatileValues()- Specified by:
hasVolatileValues
in interfaceXBasicTable<K,V>
- Specified by:
hasVolatileValues
in interfaceXTable<K,V>
-
addGet
- Specified by:
addGet
in interfaceXAddGetMap<K,V>
-
substitute
- Specified by:
substitute
in interfaceXAddGetMap<K,V>
-
putGet
Description copied from interface:XMap
Ensures the passed key and value to be contained as an entry in the map. -
replace
- Specified by:
replace
in interfaceXPutGetMap<K,V>
-
setGet
Description copied from interface:XMap
Sets the passed key and value to an appropriate entry if one can be found. -
add
Description copied from interface:XMap
Adds the passed key and value as an entry if key is not yet contained. Return value indicates new entry. -
put
Description copied from interface:XMap
Ensures the passed key and value to be contained as an entry in the map. -
set
Description copied from interface:XMap
Sets the passed key and value to an appropriate entry if one can be found. -
valuePut
Description copied from interface:XMap
Ensures the passed value to be either set to an existing entry equal to sampleKey or inserted as a new one. -
valueSet
Description copied from interface:XMap
Sets only the passed value to an existing entry appropriate to the passed sampleKey. -
valuePutGet
Description copied from interface:XMap
Ensures the passed value to be either set to an existing entry appropriate to sampleKey or inserted as a new one.- Specified by:
valuePutGet
in interfaceXMap<K,V>
- Parameters:
key
- to find the an existing elementvalue
- to add- Returns:
- the old value
-
valueSetGet
Description copied from interface:XMap
Sets only the passed value to an existing entry appropriate to the passed sampleKey.- Specified by:
valueSetGet
in interfaceXMap<K,V>
- Parameters:
key
- to find the an existing elementvalue
- to add- Returns:
- the old value
-
removeFor
- Specified by:
removeFor
in interfaceXProcessingMap<K,V>
-
analyze
- Specified by:
analyze
in interfaceHashCollection<K>
-
hashDistributionRange
public final int hashDistributionRange()- Specified by:
hashDistributionRange
in interfaceHashCollection<K>
-
hashEquality
- Specified by:
hashEquality
in interfaceHashCollection<K>
-
hashDensity
public final float hashDensity()- Specified by:
hashDensity
in interfaceHashCollection<K>
-
hasVolatileHashElements
public final boolean hasVolatileHashElements()- Specified by:
hasVolatileHashElements
in interfaceHashCollection<K>
-
toString
-
predicateContainsEntry
-
sort
Description copied from interface:Sortable
Sorts this collection according to the given comparator and returns itself.- Specified by:
sort
in interfaceSortable<K>
- Specified by:
sort
in interfaceXDecreasingEnum<K>
- Specified by:
sort
in interfaceXDecreasingSequence<K>
- Specified by:
sort
in interfaceXEnum<K>
- Specified by:
sort
in interfaceXIncreasingEnum<K>
- Specified by:
sort
in interfaceXIncreasingSequence<K>
- Specified by:
sort
in interfaceXSequence<K>
- Specified by:
sort
in interfaceXSettingEnum<K>
- Specified by:
sort
in interfaceXSettingSequence<K>
- Specified by:
sort
in interfaceXSortableEnum<K>
- Specified by:
sort
in interfaceXSortableSequence<K>
- Specified by:
sort
in interfaceXTable<K,V>
- Parameters:
comparator
- to sort this collection- Returns:
- this
-
range
- Specified by:
range
in interfaceXDecreasingEnum<K>
- Specified by:
range
in interfaceXDecreasingSequence<K>
- Specified by:
range
in interfaceXEnum<K>
- Specified by:
range
in interfaceXGettingEnum<K>
- Specified by:
range
in interfaceXGettingSequence<K>
- Specified by:
range
in interfaceXIncreasingEnum<K>
- Specified by:
range
in interfaceXIncreasingSequence<K>
- Specified by:
range
in interfaceXSettingEnum<K>
- Specified by:
range
in interfaceXSettingSequence<K>
-
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 interfaceXGettingEnum<K>
- Specified by:
view
in interfaceXGettingSequence<K>
- Specified by:
view
in interfaceXProcessingSequence<K>
- Parameters:
lowIndex
- defines lower boundary for the view of the collection.highIndex
- defines higher boundary for the view of the collection.- Returns:
- new read-only collection to view a range of 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<K>
- 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)
.- Specified by:
iterate
in interfaceXGettingEnum<K>
- Specified by:
iterate
in interfaceXGettingSet<K>
- Specified by:
iterate
in interfaceXIterable<K>
- Specified by:
iterate
in interfaceXProcessingCollection<K>
- 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. -
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<K>
- Parameters:
entry
- 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<K>
- Parameters:
predicate
- defines which elements are counted and which are not- Returns:
- Amount of matches
-
search
Description copied from interface:XGettingCollection
Returns the first contained element matching the passed predicate.- Specified by:
search
in interfaceXGettingCollection<K>
- Parameters:
predicate
- defines which element is searched- Returns:
- Matching element
-
max
- Specified by:
max
in interfaceXGettingCollection<K>
-
min
- Specified by:
min
in interfaceXGettingCollection<K>
-
containsSearched
- Specified by:
containsSearched
in interfaceXGettingCollection<K>
-
applies
Description copied from interface:XGettingCollection
Tests each element of the collection on the given predicate.- Specified by:
applies
in interfaceXGettingCollection<K>
- 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<K>
-
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<K>
- Parameters:
entry
- the element to be searched in the collection by identity.- Returns:
- whether this collection contains exactly the given element.
-
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<K>
- Parameters:
entry
- to be searched in the collection- Returns:
- Whether this collection contains the given element as specified by the
Equalator
.
-
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<K>
- Parameters:
sample
- to seek in the collection- Returns:
- the first contained element matching the passed sample
-
containsAll
- Specified by:
containsAll
in interfaceXGettingCollection<K>
- 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 KeyValue<K,V>> samples, Equalator<? super KeyValue<K,V>> equalator)- Specified by:
equals
in interfaceXGettingCollection<K>
- 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 KeyValue<K,V>> samples, Equalator<? super KeyValue<K,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<K>
- 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 KeyValue<K, V>>> C intersect(XGettingCollection<? extends KeyValue<K,V>> other, Equalator<? super KeyValue<K,V>> 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<K>
- 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
-
except
public final <C extends Consumer<? super KeyValue<K, V>>> C except(XGettingCollection<? extends KeyValue<K,V>> other, Equalator<? super KeyValue<K,V>> 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<K>
- Type Parameters:
C
- 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
-
union
public final <C extends Consumer<? super KeyValue<K, V>>> C union(XGettingCollection<? extends KeyValue<K,V>> other, Equalator<? super KeyValue<K,V>> 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<K>
- 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
-
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<K>
- Parameters:
target
- on which theConsumer.accept(Object)
is called for all elements of this collection.- Returns:
- Given target
-
filterTo
public final <C extends Consumer<? super KeyValue<K, V>>> C filterTo(C target, Predicate<? super KeyValue<K,V>> predicate)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<K>
- 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<K>
- Parameters:
target
- on which theConsumer.accept(Object)
is called for every distinct element of this collection.- Returns:
- Given target
-
distinct
public final <C extends Consumer<? super KeyValue<K, V>>> C distinct(C target, Equalator<? super KeyValue<K,V>> equalator)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<K>
- 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
-
nullAdd
public final boolean nullAdd()- Specified by:
nullAdd
in interfaceXAddingCollection<K>
-
add
Description copied from interface:XAddingCollection
Adds the passed element.- Specified by:
add
in interfaceXAddingCollection<K>
- Parameters:
entry
- to add- Returns:
true
if element was added;false
if not
-
addAll
- Specified by:
addAll
in interfaceXAddGetCollection<K>
- Specified by:
addAll
in interfaceXAddGetSet<K>
- Specified by:
addAll
in interfaceXAddingCollection<K>
- Specified by:
addAll
in interfaceXAddingEnum<K>
- Specified by:
addAll
in interfaceXAddingSequence<K>
- Specified by:
addAll
in interfaceXAddingSet<K>
- Specified by:
addAll
in interfaceXAddingTable<K,V>
- Specified by:
addAll
in interfaceXBasicEnum<K>
- Specified by:
addAll
in interfaceXBasicSequence<K>
- Specified by:
addAll
in interfaceXBasicTable<K,V>
- Specified by:
addAll
in interfaceXCollection<K>
- Specified by:
addAll
in interfaceXEnum<K>
- Specified by:
addAll
in interfaceXExpandingEnum<K>
- Specified by:
addAll
in interfaceXExpandingSequence<K>
- Specified by:
addAll
in interfaceXExtendingEnum<K>
- Specified by:
addAll
in interfaceXExtendingSequence<K>
- Specified by:
addAll
in interfaceXIncreasingEnum<K>
- Specified by:
addAll
in interfaceXIncreasingSequence<K>
- Specified by:
addAll
in interfaceXInputtingEnum<K>
- Specified by:
addAll
in interfaceXInputtingSequence<K>
- Specified by:
addAll
in interfaceXInsertingEnum<K>
- Specified by:
addAll
in interfaceXInsertingSequence<K>
- Specified by:
addAll
in interfaceXMap<K,V>
- Specified by:
addAll
in interfaceXPutGetCollection<K>
- Specified by:
addAll
in interfaceXPutGetEnum<K>
- Specified by:
addAll
in interfaceXPutGetSequence<K>
- Specified by:
addAll
in interfaceXPutGetSet<K>
- Specified by:
addAll
in interfaceXPuttingEnum<K>
- Specified by:
addAll
in interfaceXPuttingSet<K>
- Specified by:
addAll
in interfaceXSequence<K>
- Specified by:
addAll
in interfaceXSet<K>
- Specified by:
addAll
in interfaceXTable<K,V>
-
addAll
- Specified by:
addAll
in interfaceXAddGetCollection<K>
- Specified by:
addAll
in interfaceXAddGetSet<K>
- Specified by:
addAll
in interfaceXAddingCollection<K>
- Specified by:
addAll
in interfaceXAddingEnum<K>
- Specified by:
addAll
in interfaceXAddingSequence<K>
- Specified by:
addAll
in interfaceXAddingSet<K>
- Specified by:
addAll
in interfaceXAddingTable<K,V>
- Specified by:
addAll
in interfaceXBasicEnum<K>
- Specified by:
addAll
in interfaceXBasicSequence<K>
- Specified by:
addAll
in interfaceXBasicTable<K,V>
- Specified by:
addAll
in interfaceXCollection<K>
- Specified by:
addAll
in interfaceXEnum<K>
- Specified by:
addAll
in interfaceXExpandingEnum<K>
- Specified by:
addAll
in interfaceXExpandingSequence<K>
- Specified by:
addAll
in interfaceXExtendingEnum<K>
- Specified by:
addAll
in interfaceXExtendingSequence<K>
- Specified by:
addAll
in interfaceXIncreasingEnum<K>
- Specified by:
addAll
in interfaceXIncreasingSequence<K>
- Specified by:
addAll
in interfaceXInputtingEnum<K>
- Specified by:
addAll
in interfaceXInputtingSequence<K>
- Specified by:
addAll
in interfaceXInsertingEnum<K>
- Specified by:
addAll
in interfaceXInsertingSequence<K>
- Specified by:
addAll
in interfaceXMap<K,V>
- Specified by:
addAll
in interfaceXPutGetCollection<K>
- Specified by:
addAll
in interfaceXPutGetEnum<K>
- Specified by:
addAll
in interfaceXPutGetSequence<K>
- Specified by:
addAll
in interfaceXPutGetSet<K>
- Specified by:
addAll
in interfaceXPuttingEnum<K>
- Specified by:
addAll
in interfaceXPuttingSet<K>
- Specified by:
addAll
in interfaceXSequence<K>
- Specified by:
addAll
in interfaceXSet<K>
- Specified by:
addAll
in interfaceXTable<K,V>
-
addAll
- Specified by:
addAll
in interfaceXAddGetCollection<K>
- Specified by:
addAll
in interfaceXAddGetSet<K>
- Specified by:
addAll
in interfaceXAddingCollection<K>
- Specified by:
addAll
in interfaceXAddingEnum<K>
- Specified by:
addAll
in interfaceXAddingSequence<K>
- Specified by:
addAll
in interfaceXAddingSet<K>
- Specified by:
addAll
in interfaceXAddingTable<K,V>
- Specified by:
addAll
in interfaceXBasicEnum<K>
- Specified by:
addAll
in interfaceXBasicSequence<K>
- Specified by:
addAll
in interfaceXBasicTable<K,V>
- Specified by:
addAll
in interfaceXCollection<K>
- Specified by:
addAll
in interfaceXEnum<K>
- Specified by:
addAll
in interfaceXExpandingEnum<K>
- Specified by:
addAll
in interfaceXExpandingSequence<K>
- Specified by:
addAll
in interfaceXExtendingEnum<K>
- Specified by:
addAll
in interfaceXExtendingSequence<K>
- Specified by:
addAll
in interfaceXIncreasingEnum<K>
- Specified by:
addAll
in interfaceXIncreasingSequence<K>
- Specified by:
addAll
in interfaceXInputtingEnum<K>
- Specified by:
addAll
in interfaceXInputtingSequence<K>
- Specified by:
addAll
in interfaceXInsertingEnum<K>
- Specified by:
addAll
in interfaceXInsertingSequence<K>
- Specified by:
addAll
in interfaceXMap<K,V>
- Specified by:
addAll
in interfaceXPutGetCollection<K>
- Specified by:
addAll
in interfaceXPutGetEnum<K>
- Specified by:
addAll
in interfaceXPutGetSequence<K>
- Specified by:
addAll
in interfaceXPutGetSet<K>
- Specified by:
addAll
in interfaceXPuttingEnum<K>
- Specified by:
addAll
in interfaceXPuttingSet<K>
- Specified by:
addAll
in interfaceXSequence<K>
- Specified by:
addAll
in interfaceXSet<K>
- Specified by:
addAll
in interfaceXTable<K,V>
-
nullPut
public final boolean nullPut()- Specified by:
nullPut
in interfaceXPuttingCollection<K>
-
accept
-
put
Description copied from interface:XPuttingCollection
Adds the specified element to this collection if it is not already present (optional operation).- Specified by:
put
in interfaceXPuttingCollection<K>
- Parameters:
entry
- to add- Returns:
- true if this collection did not already contain the specified element
-
addGet
- Specified by:
addGet
in interfaceXAddGetSet<K>
-
deduplicate
- Specified by:
deduplicate
in interfaceXAddGetSet<K>
-
putGet
- Specified by:
putGet
in interfaceXPutGetSet<K>
-
replace
- Specified by:
replace
in interfaceXPutGetSet<K>
-
putAll
Description copied from interface:XMap
Ensures the passed key-value-pairs to be contained as entries in the map. A return value indicates a new entry.- Specified by:
putAll
in interfaceXBasicEnum<K>
- Specified by:
putAll
in interfaceXBasicSequence<K>
- Specified by:
putAll
in interfaceXBasicTable<K,V>
- Specified by:
putAll
in interfaceXCollection<K>
- Specified by:
putAll
in interfaceXEnum<K>
- Specified by:
putAll
in interfaceXExpandingEnum<K>
- Specified by:
putAll
in interfaceXExpandingSequence<K>
- Specified by:
putAll
in interfaceXIncreasingEnum<K>
- Specified by:
putAll
in interfaceXIncreasingSequence<K>
- Specified by:
putAll
in interfaceXInputtingEnum<K>
- Specified by:
putAll
in interfaceXInputtingSequence<K>
- Specified by:
putAll
in interfaceXMap<K,V>
- Specified by:
putAll
in interfaceXPutGetCollection<K>
- Specified by:
putAll
in interfaceXPutGetEnum<K>
- Specified by:
putAll
in interfaceXPutGetSequence<K>
- Specified by:
putAll
in interfaceXPutGetSet<K>
- Specified by:
putAll
in interfaceXPuttingCollection<K>
- Specified by:
putAll
in interfaceXPuttingEnum<K>
- Specified by:
putAll
in interfaceXPuttingSequence<K>
- Specified by:
putAll
in interfaceXPuttingSet<K>
- Specified by:
putAll
in interfaceXSequence<K>
- Specified by:
putAll
in interfaceXSet<K>
- Specified by:
putAll
in interfaceXTable<K,V>
- Parameters:
elements
- to add- Returns:
- this
-
putAll
Description copied from interface:XMap
Ensures the passed key-value-pairs to be contained as entries in the map. Only the elements with indizes from the srcStartIndex to the srcStartIndex+srcLength are put in the collection.
A return value indicates a new entry.- Specified by:
putAll
in interfaceXBasicEnum<K>
- Specified by:
putAll
in interfaceXBasicSequence<K>
- Specified by:
putAll
in interfaceXBasicTable<K,V>
- Specified by:
putAll
in interfaceXCollection<K>
- Specified by:
putAll
in interfaceXEnum<K>
- Specified by:
putAll
in interfaceXExpandingEnum<K>
- Specified by:
putAll
in interfaceXExpandingSequence<K>
- Specified by:
putAll
in interfaceXIncreasingEnum<K>
- Specified by:
putAll
in interfaceXIncreasingSequence<K>
- Specified by:
putAll
in interfaceXInputtingEnum<K>
- Specified by:
putAll
in interfaceXInputtingSequence<K>
- Specified by:
putAll
in interfaceXMap<K,V>
- Specified by:
putAll
in interfaceXPutGetCollection<K>
- Specified by:
putAll
in interfaceXPutGetEnum<K>
- Specified by:
putAll
in interfaceXPutGetSequence<K>
- Specified by:
putAll
in interfaceXPutGetSet<K>
- Specified by:
putAll
in interfaceXPuttingCollection<K>
- Specified by:
putAll
in interfaceXPuttingEnum<K>
- Specified by:
putAll
in interfaceXPuttingSequence<K>
- Specified by:
putAll
in interfaceXPuttingSet<K>
- Specified by:
putAll
in interfaceXSequence<K>
- Specified by:
putAll
in interfaceXSet<K>
- Specified by:
putAll
in interfaceXTable<K,V>
- Parameters:
elements
- to addsrcIndex
- start index of elements-array to add to collectionsrcLength
- length of elements-array to add to collection- Returns:
- this
-
putAll
Description copied from interface:XPuttingCollection
Adds the specified elements to this collection if it is not already present (optional operation).- Specified by:
putAll
in interfaceXBasicEnum<K>
- Specified by:
putAll
in interfaceXBasicSequence<K>
- Specified by:
putAll
in interfaceXBasicTable<K,V>
- Specified by:
putAll
in interfaceXCollection<K>
- Specified by:
putAll
in interfaceXEnum<K>
- Specified by:
putAll
in interfaceXExpandingEnum<K>
- Specified by:
putAll
in interfaceXExpandingSequence<K>
- Specified by:
putAll
in interfaceXIncreasingEnum<K>
- Specified by:
putAll
in interfaceXIncreasingSequence<K>
- Specified by:
putAll
in interfaceXInputtingEnum<K>
- Specified by:
putAll
in interfaceXInputtingSequence<K>
- Specified by:
putAll
in interfaceXPutGetCollection<K>
- Specified by:
putAll
in interfaceXPutGetEnum<K>
- Specified by:
putAll
in interfaceXPutGetSequence<K>
- Specified by:
putAll
in interfaceXPutGetSet<K>
- Specified by:
putAll
in interfaceXPuttingCollection<K>
- Specified by:
putAll
in interfaceXPuttingEnum<K>
- Specified by:
putAll
in interfaceXPuttingSequence<K>
- Specified by:
putAll
in interfaceXPuttingSet<K>
- Specified by:
putAll
in interfaceXSequence<K>
- Specified by:
putAll
in interfaceXSet<K>
- Specified by:
putAll
in interfaceXTable<K,V>
- Parameters:
elements
- to add- Returns:
- this
-
remove
- Specified by:
remove
in interfaceXRemovingCollection<K>
-
nullRemove
public final long nullRemove()- Specified by:
nullRemove
in interfaceXRemovingCollection<K>
-
removeBy
- Specified by:
removeBy
in interfaceXProcessingCollection<K>
-
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<K>
- Parameters:
elements
- to retain- Returns:
- Amount of deleted elements
-
process
- Specified by:
process
in interfaceProcessable<K>
-
moveTo
public final <C extends Consumer<? super KeyValue<K, V>>> C moveTo(C target, Predicate<? super KeyValue<K,V>> predicate)- Specified by:
moveTo
in interfaceXProcessingCollection<K>
-
removeAll
- Specified by:
removeAll
in interfaceXRemovingCollection<K>
-
removeDuplicates
public final long removeDuplicates()- Specified by:
removeDuplicates
in interfaceXRemovingCollection<K>
-
removeDuplicates
- Specified by:
removeDuplicates
in interfaceXProcessingCollection<K>
-
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 interfaceXBasicEnum<K>
- Specified by:
toReversed
in interfaceXBasicSequence<K>
- Specified by:
toReversed
in interfaceXDecreasingEnum<K>
- Specified by:
toReversed
in interfaceXDecreasingSequence<K>
- Specified by:
toReversed
in interfaceXEnum<K>
- Specified by:
toReversed
in interfaceXGettingEnum<K>
- Specified by:
toReversed
in interfaceXGettingSequence<K>
- Specified by:
toReversed
in interfaceXIncreasingEnum<K>
- Specified by:
toReversed
in interfaceXIncreasingSequence<K>
- Specified by:
toReversed
in interfaceXProcessingEnum<K>
- Specified by:
toReversed
in interfaceXProcessingSequence<K>
- Specified by:
toReversed
in interfaceXPutGetEnum<K>
- Specified by:
toReversed
in interfaceXPutGetSequence<K>
- Specified by:
toReversed
in interfaceXSequence<K>
- Specified by:
toReversed
in interfaceXSettingEnum<K>
- Specified by:
toReversed
in interfaceXSettingSequence<K>
- Specified by:
toReversed
in interfaceXSortableEnum<K>
- Specified by:
toReversed
in interfaceXSortableSequence<K>
- Returns:
- New copy of the collection
-
copySelection
public final <T extends Consumer<? super KeyValue<K, V>>> T copySelection(T target, long... indices)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<K>
- 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
-
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<K>
- Type Parameters:
P
- type of procedure- Parameters:
procedure
- which is executed when iterating- Returns:
- Given procedure
-
at
- Specified by:
at
in interfaceXGettingSequence<K>
-
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<K>
- Specified by:
get
in interfaceXGettingSequence<K>
- 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<K>
- Returns:
- First element
-
last
Description copied from interface:XGettingSequence
Gets last element or throwsIndexOutOfBoundsException
if the collection is empty.- Specified by:
last
in interfaceXGettingSequence<K>
- Returns:
- Last element
-
poll
Description copied from interface:XGettingSequence
Gets first element or null if the collection is empty.- Specified by:
poll
in interfaceXGettingSequence<K>
- 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<K>
- Returns:
- Last element or null
-
indexOf
- Specified by:
indexOf
in interfaceXGettingSequence<K>
-
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<K>
- 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<K>
- Parameters:
comparator
- defines if elements are sorted- Returns:
- true if it sorted, false if not
-
lastIndexOf
- Specified by:
lastIndexOf
in interfaceXGettingSequence<K>
-
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<K>
- Parameters:
predicate
- to define a valid element- Returns:
- the index of the last positively tested element.
-
maxIndex
- Specified by:
maxIndex
in interfaceXGettingSequence<K>
-
minIndex
- Specified by:
minIndex
in interfaceXGettingSequence<K>
-
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<K>
- Parameters:
predicate
- to define a valid element- Returns:
- the index of the last positively tested element.
-
moveSelection
public final <C extends Consumer<? super KeyValue<K, V>>> C moveSelection(C target, long... indices)- Specified by:
moveSelection
in interfaceXProcessingSequence<K>
-
removeAt
- Specified by:
removeAt
in interfaceXProcessingSequence<K>
-
fetch
- Specified by:
fetch
in interfaceXProcessingCollection<K>
-
pop
- Specified by:
pop
in interfaceXProcessingSequence<K>
-
pinch
- Specified by:
pinch
in interfaceXProcessingCollection<K>
-
pick
- Specified by:
pick
in interfaceXProcessingSequence<K>
-
retrieve
- Specified by:
retrieve
in interfaceXProcessingCollection<K>
-
retrieveBy
- Specified by:
retrieveBy
in interfaceXProcessingCollection<K>
-
removeOne
- Specified by:
removeOne
in interfaceXRemovingCollection<K>
-
removeRange
- Specified by:
removeRange
in interfaceXRemovingSequence<K>
-
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<K>
- 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<K>
-
iterator
-
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<K>
- Returns:
- an array containing all of the elements in this collection
-
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 interfaceXDecreasingEnum<K>
- Specified by:
reverse
in interfaceXDecreasingSequence<K>
- Specified by:
reverse
in interfaceXEnum<K>
- Specified by:
reverse
in interfaceXIncreasingEnum<K>
- Specified by:
reverse
in interfaceXIncreasingSequence<K>
- Specified by:
reverse
in interfaceXOrderingEnum<K>
- Specified by:
reverse
in interfaceXOrderingSequence<K>
- Specified by:
reverse
in interfaceXSettingEnum<K>
- Specified by:
reverse
in interfaceXSettingSequence<K>
- Specified by:
reverse
in interfaceXSortableEnum<K>
- Specified by:
reverse
in interfaceXSortableSequence<K>
- Returns:
- this
-
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 interfaceXOrderingEnum<K>
- Specified by:
shiftTo
in interfaceXOrderingSequence<K>
- Specified by:
shiftTo
in interfaceXSortableEnum<K>
- Specified by:
shiftTo
in interfaceXSortableSequence<K>
- 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 interfaceXOrderingEnum<K>
- Specified by:
shiftTo
in interfaceXOrderingSequence<K>
- Specified by:
shiftTo
in interfaceXSortableEnum<K>
- Specified by:
shiftTo
in interfaceXSortableSequence<K>
- 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 interfaceXOrderingEnum<K>
- Specified by:
shiftBy
in interfaceXOrderingSequence<K>
- Specified by:
shiftBy
in interfaceXSortableEnum<K>
- Specified by:
shiftBy
in interfaceXSortableSequence<K>
- 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 interfaceXOrderingEnum<K>
- Specified by:
shiftBy
in interfaceXOrderingSequence<K>
- Specified by:
shiftBy
in interfaceXSortableEnum<K>
- Specified by:
shiftBy
in interfaceXSortableSequence<K>
- 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 interfaceXDecreasingEnum<K>
- Specified by:
swap
in interfaceXDecreasingSequence<K>
- Specified by:
swap
in interfaceXEnum<K>
- Specified by:
swap
in interfaceXIncreasingEnum<K>
- Specified by:
swap
in interfaceXIncreasingSequence<K>
- Specified by:
swap
in interfaceXOrderingEnum<K>
- Specified by:
swap
in interfaceXOrderingSequence<K>
- Specified by:
swap
in interfaceXSettingEnum<K>
- Specified by:
swap
in interfaceXSettingSequence<K>
- Specified by:
swap
in interfaceXSortableEnum<K>
- Specified by:
swap
in interfaceXSortableSequence<K>
-
swap
- Specified by:
swap
in interfaceXDecreasingEnum<K>
- Specified by:
swap
in interfaceXDecreasingSequence<K>
- Specified by:
swap
in interfaceXEnum<K>
- Specified by:
swap
in interfaceXIncreasingEnum<K>
- Specified by:
swap
in interfaceXIncreasingSequence<K>
- Specified by:
swap
in interfaceXOrderingEnum<K>
- Specified by:
swap
in interfaceXOrderingSequence<K>
- Specified by:
swap
in interfaceXSettingEnum<K>
- Specified by:
swap
in interfaceXSettingSequence<K>
- Specified by:
swap
in interfaceXSortableEnum<K>
- Specified by:
swap
in interfaceXSortableSequence<K>
-
equality
- Specified by:
equality
in interfaceXGettingCollection<K>
-
input
- Specified by:
input
in interfaceXInputtingSequence<K>
-
inputAll
- Specified by:
inputAll
in interfaceXInputtingSequence<K>
-
inputAll
- Specified by:
inputAll
in interfaceXInputtingSequence<K>
-
inputAll
- Specified by:
inputAll
in interfaceXInputtingSequence<K>
-
insert
- Specified by:
insert
in interfaceXInsertingSequence<K>
-
insertAll
- Specified by:
insertAll
in interfaceXInsertingSequence<K>
-
insertAll
- Specified by:
insertAll
in interfaceXInsertingSequence<K>
-
insertAll
- Specified by:
insertAll
in interfaceXInsertingSequence<K>
-
prepend
- Specified by:
prepend
in interfaceXPrependingSequence<K>
-
preput
- Specified by:
preput
in interfaceXPreputtingSequence<K>
-
nullInput
public final boolean nullInput(long index)- Specified by:
nullInput
in interfaceXInputtingSequence<K>
-
nullInsert
public final boolean nullInsert(long index)- Specified by:
nullInsert
in interfaceXInsertingSequence<K>
-
nullPrepend
public final boolean nullPrepend()- Specified by:
nullPrepend
in interfaceXPrependingSequence<K>
-
prependAll
- Specified by:
prependAll
in interfaceXEnum<K>
- Specified by:
prependAll
in interfaceXExpandingEnum<K>
- Specified by:
prependAll
in interfaceXExpandingSequence<K>
- Specified by:
prependAll
in interfaceXExtendingEnum<K>
- Specified by:
prependAll
in interfaceXExtendingSequence<K>
- Specified by:
prependAll
in interfaceXIncreasingEnum<K>
- Specified by:
prependAll
in interfaceXIncreasingSequence<K>
- Specified by:
prependAll
in interfaceXInputtingEnum<K>
- Specified by:
prependAll
in interfaceXInputtingSequence<K>
- Specified by:
prependAll
in interfaceXInsertingEnum<K>
- Specified by:
prependAll
in interfaceXInsertingSequence<K>
- Specified by:
prependAll
in interfaceXPrependingEnum<K>
- Specified by:
prependAll
in interfaceXPrependingSequence<K>
- Specified by:
prependAll
in interfaceXPreputtingEnum<K>
- Specified by:
prependAll
in interfaceXPreputtingSequence<K>
-
prependAll
public final HashTable<K,V> prependAll(KeyValue<K,V>[] elements, int srcStartIndex, int srcLength)- Specified by:
prependAll
in interfaceXEnum<K>
- Specified by:
prependAll
in interfaceXExpandingEnum<K>
- Specified by:
prependAll
in interfaceXExpandingSequence<K>
- Specified by:
prependAll
in interfaceXExtendingEnum<K>
- Specified by:
prependAll
in interfaceXExtendingSequence<K>
- Specified by:
prependAll
in interfaceXIncreasingEnum<K>
- Specified by:
prependAll
in interfaceXIncreasingSequence<K>
- Specified by:
prependAll
in interfaceXInputtingEnum<K>
- Specified by:
prependAll
in interfaceXInputtingSequence<K>
- Specified by:
prependAll
in interfaceXInsertingEnum<K>
- Specified by:
prependAll
in interfaceXInsertingSequence<K>
- Specified by:
prependAll
in interfaceXPrependingEnum<K>
- Specified by:
prependAll
in interfaceXPrependingSequence<K>
- Specified by:
prependAll
in interfaceXPreputtingEnum<K>
- Specified by:
prependAll
in interfaceXPreputtingSequence<K>
-
prependAll
- Specified by:
prependAll
in interfaceXEnum<K>
- Specified by:
prependAll
in interfaceXExpandingEnum<K>
- Specified by:
prependAll
in interfaceXExpandingSequence<K>
- Specified by:
prependAll
in interfaceXExtendingEnum<K>
- Specified by:
prependAll
in interfaceXExtendingSequence<K>
- Specified by:
prependAll
in interfaceXIncreasingEnum<K>
- Specified by:
prependAll
in interfaceXIncreasingSequence<K>
- Specified by:
prependAll
in interfaceXInputtingEnum<K>
- Specified by:
prependAll
in interfaceXInputtingSequence<K>
- Specified by:
prependAll
in interfaceXInsertingEnum<K>
- Specified by:
prependAll
in interfaceXInsertingSequence<K>
- Specified by:
prependAll
in interfaceXPrependingEnum<K>
- Specified by:
prependAll
in interfaceXPrependingSequence<K>
- Specified by:
prependAll
in interfaceXPreputtingEnum<K>
- Specified by:
prependAll
in interfaceXPreputtingSequence<K>
-
nullPreput
public final boolean nullPreput()- Specified by:
nullPreput
in interfaceXPreputtingSequence<K>
-
preputAll
- Specified by:
preputAll
in interfaceXEnum<K>
- Specified by:
preputAll
in interfaceXExpandingEnum<K>
- Specified by:
preputAll
in interfaceXExpandingSequence<K>
- Specified by:
preputAll
in interfaceXIncreasingEnum<K>
- Specified by:
preputAll
in interfaceXIncreasingSequence<K>
- Specified by:
preputAll
in interfaceXInputtingEnum<K>
- Specified by:
preputAll
in interfaceXInputtingSequence<K>
- Specified by:
preputAll
in interfaceXPreputtingEnum<K>
- Specified by:
preputAll
in interfaceXPreputtingSequence<K>
-
preputAll
- Specified by:
preputAll
in interfaceXEnum<K>
- Specified by:
preputAll
in interfaceXExpandingEnum<K>
- Specified by:
preputAll
in interfaceXExpandingSequence<K>
- Specified by:
preputAll
in interfaceXIncreasingEnum<K>
- Specified by:
preputAll
in interfaceXIncreasingSequence<K>
- Specified by:
preputAll
in interfaceXInputtingEnum<K>
- Specified by:
preputAll
in interfaceXInputtingSequence<K>
- Specified by:
preputAll
in interfaceXPreputtingEnum<K>
- Specified by:
preputAll
in interfaceXPreputtingSequence<K>
-
preputAll
- Specified by:
preputAll
in interfaceXEnum<K>
- Specified by:
preputAll
in interfaceXExpandingEnum<K>
- Specified by:
preputAll
in interfaceXExpandingSequence<K>
- Specified by:
preputAll
in interfaceXIncreasingEnum<K>
- Specified by:
preputAll
in interfaceXIncreasingSequence<K>
- Specified by:
preputAll
in interfaceXInputtingEnum<K>
- Specified by:
preputAll
in interfaceXInputtingSequence<K>
- Specified by:
preputAll
in interfaceXPreputtingEnum<K>
- Specified by:
preputAll
in interfaceXPreputtingSequence<K>
-
set
- Specified by:
set
in interfaceXSettingSequence<K>
-
setGet
- Specified by:
setGet
in interfaceXSettingEnum<K>
- Specified by:
setGet
in interfaceXSettingSequence<K>
-
setFirst
- Specified by:
setFirst
in interfaceXSettingEnum<K>
- Specified by:
setFirst
in interfaceXSettingSequence<K>
-
setLast
- Specified by:
setLast
in interfaceXSettingEnum<K>
- Specified by:
setLast
in interfaceXSettingSequence<K>
-
setAll
- Specified by:
setAll
in interfaceXDecreasingEnum<K>
- Specified by:
setAll
in interfaceXDecreasingSequence<K>
- Specified by:
setAll
in interfaceXEnum<K>
- Specified by:
setAll
in interfaceXSettingEnum<K>
- Specified by:
setAll
in interfaceXSettingSequence<K>
-
set
- Specified by:
set
in interfaceXDecreasingEnum<K>
- Specified by:
set
in interfaceXDecreasingSequence<K>
- Specified by:
set
in interfaceXEnum<K>
- Specified by:
set
in interfaceXSettingEnum<K>
- Specified by:
set
in interfaceXSettingSequence<K>
-
set
public final HashTable<K,V> set(long index, XGettingSequence<? extends KeyValue<K,V>> elements, long offset, long length)- Specified by:
set
in interfaceXDecreasingEnum<K>
- Specified by:
set
in interfaceXDecreasingSequence<K>
- Specified by:
set
in interfaceXEnum<K>
- Specified by:
set
in interfaceXSettingEnum<K>
- Specified by:
set
in interfaceXSettingSequence<K>
-
substitute
- Specified by:
substitute
in interfaceXDecreasingEnum<K>
- Specified by:
substitute
in interfaceXReplacingCollection<K>
-