public final class LockedMap<K,V> extends Object implements XMap<K,V>, Synchronized
XMap.Bridge<K,V>, XMap.Creator<K,V>, XMap.EntriesBridge<K,V>, XMap.Keys<K,V>, XMap.Satellite<K,V>, XMap.Values<K,V>XRemovingMap.Factory<K,V>XSet.Factory<E>XIterable.Executor<E>Copyable.Static| Modifier and Type | Method and Description |
|---|---|
void |
accept(KeyValue<K,V> element) |
boolean |
add(KeyValue<K,V> element)
Adds the passed element.
|
boolean |
add(K key,
V value)
Adds the passed key and value as an entry if key is not yet contained.
|
XMap<K,V> |
addAll(KeyValue<K,V>... elements) |
XMap<K,V> |
addAll(KeyValue<K,V>[] elements,
int srcStartIndex,
int srcLength) |
XMap<K,V> |
addAll(XGettingCollection<? extends KeyValue<K,V>> elements) |
KeyValue<K,V> |
addGet(KeyValue<K,V> element) |
KeyValue<K,V> |
addGet(K key,
V value) |
boolean |
applies(Predicate<? super KeyValue<K,V>> predicate)
Tests each element of the collection on the given predicate.
|
void |
clear()
Clears all elements from the collection while leaving the capacity as it is.
|
Aggregator<KeyValue<K,V>,? extends XCollection<KeyValue<K,V>>> |
collector() |
long |
consolidate()
Consolidates the internal storage of this collection by discarding all elements of the internal storage that
have become obsolete or otherwise unneeded anymore.
|
boolean |
contains(KeyValue<K,V> element)
Checks if the given element is contained in the collection.
|
boolean |
containsAll(XGettingCollection<? extends KeyValue<K,V>> elements) |
boolean |
containsId(KeyValue<K,V> element)
Special version of contains() that guarantees to use identity comparison (" == ") when searching for the
given element regardless of the collection's internal logic.
This method has the same behavior as XGettingCollection.containsSearched(Predicate) with a Predicate implementation
that checks for object identity. |
boolean |
containsSearched(Predicate<? super KeyValue<K,V>> predicate) |
XMap<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>>> |
copyTo(T target)
Calls
Consumer.accept(Object) on the target Consumer for all the elements of this collection. |
long |
count(KeyValue<K,V> element)
Count how many times this element matches another element in the collection
using the
Equalator. |
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.
|
long |
currentFreeCapacity() |
KeyValue<K,V> |
deduplicate(KeyValue<K,V> element) |
<T extends Consumer<? super KeyValue<K,V>>> |
distinct(T target)
Calls
Consumer.accept(Object) on the target Consumer for all the unique/distinct
elements of this collection. |
<T extends Consumer<? super KeyValue<K,V>>> |
distinct(T target,
Equalator<? super KeyValue<K,V>> equalator)
Calls
Consumer.accept(Object) on the target Consumer 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 minimalFreeCapacity)
Ensures that the next minimalFreeCapacity elements can be actually added in a fast way,
meaning for example no internal storage rebuild will be necessary.
|
Equalator<? super KeyValue<K,V>> |
equality() |
boolean |
equals(Object o)
Deprecated.
|
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)
Returns
true if all elements of this list and the passed list are sequentially equal as defined
by the passed equalator. |
<T extends Consumer<? super KeyValue<K,V>>> |
except(XGettingCollection<? extends KeyValue<K,V>> other,
Equalator<? super KeyValue<K,V>> equalator,
T target)
Calls
Consumer.accept(Object) on the target Consumer for each
element of this collection that is not contained in the other collection (through the given equalator). |
KeyValue<K,V> |
fetch() |
<T extends Consumer<? super KeyValue<K,V>>> |
filterTo(T target,
Predicate<? super KeyValue<K,V>> predicate)
Calls
Consumer.accept(Object) on the target Consumer for all the elements of this collection
which test true on the given predicate. |
void |
forEach(Consumer<? super KeyValue<K,V>> action) |
KeyValue<K,V> |
get()
Gets one element from the collection.
|
V |
get(K key) |
int |
hashCode()
Deprecated.
|
boolean |
hasVolatileElements()
Tells if this collection contains volatile elements.
An element is volatile, if it can become no longer reachable by the collection without being removed from the collection. |
XImmutableMap<K,V> |
immure()
Provides an instance of an immutable collection type with equal behavior and data as this instance.
|
<T extends Consumer<? super KeyValue<K,V>>> |
intersect(XGettingCollection<? extends KeyValue<K,V>> other,
Equalator<? super KeyValue<K,V>> equalator,
T target)
Tests equality between each element of the two lists and calls
Consumer.accept(Object) on the target Consumer for the
equal elements.Therefore it effectively creates a mathematical intersection between the two collections. |
boolean |
isEmpty() |
boolean |
isFull() |
<P extends Consumer<? super KeyValue<K,V>>> |
iterate(P procedure)
Executes the given procedure for each element of the
XIterable
until all elements have been processed or the action throws an
exception. |
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.
|
XMap.Keys<K,V> |
keys() |
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. |
KeyValue<K,V> |
min(Comparator<? super KeyValue<K,V>> comparator) |
<C extends Consumer<? super KeyValue<K,V>>> |
moveTo(C target,
Predicate<? super KeyValue<K,V>> predicate) |
static <K,V> LockedMap<K,V> |
New(XMap<K,V> subject) |
static <K,V> LockedMap<K,V> |
New(XMap<K,V> subject,
Object lock) |
boolean |
nullAdd() |
boolean |
nullAllowed()
Defines if null-elements are allowed inside the collection or not.
|
boolean |
nullContained() |
boolean |
nullKeyAllowed() |
boolean |
nullPut() |
long |
nullRemove() |
boolean |
nullValuesAllowed() |
XMap.EntriesBridge<K,V> |
old() |
XMap.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> |
pinch() |
<P extends Consumer<? super KeyValue<K,V>>> |
process(P processor) |
boolean |
put(KeyValue<K,V> element)
Adds the specified element to this collection if it is not already present (optional operation).
|
boolean |
put(K key,
V value)
Ensures the passed key and value to be contained as an entry in the map.
|
XMap<K,V> |
putAll(KeyValue<K,V>... elements)
Ensures the passed key-value-pairs to be contained as entries in the map.
|
XMap<K,V> |
putAll(KeyValue<K,V>[] elements,
int srcStartIndex,
int srcLength)
Ensures the passed key-value-pairs to be contained as entries in the map.
|
XSet<KeyValue<K,V>> |
putAll(XGettingCollection<? extends KeyValue<K,V>> elements)
Adds the specified elements to this collection if it is not already present (optional operation).
|
KeyValue<K,V> |
putGet(KeyValue<K,V> element) |
KeyValue<K,V> |
putGet(K key,
V value)
Ensures the passed key and value to be contained as an entry in the map.
|
<C extends Consumer<? super V>> |
query(XIterable<? extends K> keys,
C collector) |
long |
remainingCapacity() |
long |
remove(KeyValue<K,V> element) |
long |
removeAll(XGettingCollection<? extends KeyValue<K,V>> elements) |
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> element) |
KeyValue<K,V> |
replace(KeyValue<K,V> element) |
KeyValue<K,V> |
replace(K key,
V value) |
long |
retainAll(XGettingCollection<? extends KeyValue<K,V>> elements)
Removing all elements except the ones contained in the given elements-collection.
|
KeyValue<K,V> |
retrieve(KeyValue<K,V> element) |
KeyValue<K,V> |
retrieveBy(Predicate<? super KeyValue<K,V>> predicate) |
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.
|
boolean |
set(K key,
V value)
Sets the passed key and value to an appropriate entry if one can be found.
|
KeyValue<K,V> |
setGet(K key,
V value)
Sets the passed key and value to an appropriate entry if one can be found.
|
long |
size() |
Spliterator<KeyValue<K,V>> |
spliterator() |
KeyValue<K,V> |
substitute(K key,
V value) |
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.
|
void |
truncate()
Clears (and reinitializes if needed) this collection in the fastest possible way, i.e.
|
<T extends Consumer<? super KeyValue<K,V>>> |
union(XGettingCollection<? extends KeyValue<K,V>> other,
Equalator<? super KeyValue<K,V>> equalator,
T target)
Calls
Consumer.accept(Object) on the target Consumer for all the elements of this collection. |
boolean |
valuePut(K sampleKey,
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 sampleKey,
V value)
Ensures the passed value to be either set to an existing entry appropriate to sampleKey or inserted as a new one.
|
XMap.Values<K,V> |
values() |
boolean |
valueSet(K sampleKey,
V value)
Sets only the passed value to an existing entry appropriate to the passed sampleKey.
|
V |
valueSetGet(K sampleKey,
V value)
Sets only the passed value to an existing entry appropriate to the passed sampleKey.
|
XGettingMap<K,V> |
view()
Creates a view of this collection and returns it.
|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitintSizepublic final long maximumCapacity()
CapacityCarryingInteger.MAX_VALUE)maximumCapacity in interface CapacityCarryingpublic final <P extends Consumer<? super KeyValue<K,V>>> P process(P processor)
process in interface Processable<KeyValue<K,V>>public final void clear()
XRemovingCollectionpublic final <A> A join(BiConsumer<? super KeyValue<K,V>,? super A> joiner, A aggregate)
XJoinablepublic final boolean nullAllowed()
ExtendedCollectionnullAllowed in interface ExtendedCollection<KeyValue<K,V>>true if null is allowed inside the collection; false if notpublic final long optimize()
OptimizableCollectionoptimize in interface OptimizableCollectionoptimize in interface XRemovingCollection<KeyValue<K,V>>public final long consolidate()
ConsolidatableCollectionWeakReference entries whose reference has
been cleared).consolidate in interface ConsolidatableCollectionconsolidate in interface XRemovingCollection<KeyValue<K,V>>public final void truncate()
XRemovingCollectiontruncate in interface Truncateabletruncate in interface XRemovingCollection<KeyValue<K,V>>public final KeyValue<K,V> addGet(KeyValue<K,V> element)
addGet in interface XAddGetSet<KeyValue<K,V>>public final KeyValue<K,V> deduplicate(KeyValue<K,V> element)
deduplicate in interface XAddGetSet<KeyValue<K,V>>public final KeyValue<K,V> putGet(KeyValue<K,V> element)
putGet in interface XPutGetSet<KeyValue<K,V>>public final KeyValue<K,V> replace(KeyValue<K,V> element)
replace in interface XPutGetSet<KeyValue<K,V>>public final KeyValue<K,V> addGet(K key, V value)
addGet in interface XAddGetMap<K,V>public KeyValue<K,V> substitute(K key, V value)
substitute in interface XAddGetMap<K,V>public KeyValue<K,V> replace(K key, V value)
replace in interface XPutGetMap<K,V>public final boolean hasVolatileElements()
ExtendedCollectionWeakReference of SoftReference or implementations of collection entries
that remove the element contained in an entry by some means outside the collection.WeakReference 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.hasVolatileElements in interface ExtendedCollection<KeyValue<K,V>>hasVolatileElements in interface XGettingCollection<KeyValue<K,V>>true if the collection contains volatile elements.public final V ensure(K key, Function<? super K,V> valueProvider)
XAddGetMapIf 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.
ensure in interface XAddGetMap<K,V>key - the search key.valueProvider - the value supplier used to provide a value for the passed key in case non could be found.public final <P extends Consumer<? super KeyValue<K,V>>> P iterate(P procedure)
XIterableXIterable
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.Iterable.forEach(Consumer).iterate in interface XGettingSet<KeyValue<K,V>>iterate in interface XIterable<KeyValue<K,V>>iterate in interface XProcessingCollection<KeyValue<K,V>>P - type of procedureprocedure - The procedure to be performed for each elementpublic final Aggregator<KeyValue<K,V>,? extends XCollection<KeyValue<K,V>>> collector()
collector in interface XAddingCollection<KeyValue<K,V>>collector in interface XCollection<KeyValue<K,V>>public final XSet<KeyValue<K,V>> putAll(XGettingCollection<? extends KeyValue<K,V>> elements)
XPuttingCollectionputAll in interface XCollection<KeyValue<K,V>>putAll in interface XPutGetCollection<KeyValue<K,V>>putAll in interface XPutGetSet<KeyValue<K,V>>putAll in interface XPuttingCollection<KeyValue<K,V>>putAll in interface XPuttingSet<KeyValue<K,V>>putAll in interface XSet<KeyValue<K,V>>elements - to addpublic final XMap.Values<K,V> values()
public final CapacityExtendable ensureCapacity(long minimalCapacity)
ensureCapacity in interface CapacityExtendablepublic final long remainingCapacity()
remainingCapacity in interface CapacityCarryingpublic final XMap.EntriesBridge<K,V> old()
public final XMap.Bridge<K,V> oldMap()
public final CapacityExtendable ensureFreeCapacity(long minimalFreeCapacity)
CapacityExtendableensureFreeCapacity in interface CapacityExtendableminimalFreeCapacity - the capacity to ensurepublic final XMap<K,V> copy()
XGettingCollectioncopy in interface XAddGetCollection<KeyValue<K,V>>copy in interface XAddGetSet<KeyValue<K,V>>copy in interface XCollection<KeyValue<K,V>>copy in interface XGettingCollection<KeyValue<K,V>>copy in interface XGettingMap<K,V>copy in interface XGettingSet<KeyValue<K,V>>copy in interface XMap<K,V>copy in interface XProcessingMap<K,V>copy in interface XProcessingSet<KeyValue<K,V>>copy in interface XPutGetCollection<KeyValue<K,V>>copy in interface XPutGetSet<KeyValue<K,V>>copy in interface XSet<KeyValue<K,V>>copy in interface Copyablepublic final <C extends Consumer<? super V>> C query(XIterable<? extends K> keys, C collector)
query in interface XGettingMap<K,V>public final boolean put(KeyValue<K,V> element)
XPuttingCollectionput in interface XPuttingCollection<KeyValue<K,V>>element - to addpublic final boolean nullKeyAllowed()
nullKeyAllowed in interface XAddingMap<K,V>nullKeyAllowed in interface XGettingMap<K,V>nullKeyAllowed in interface XMap<K,V>public final boolean nullPut()
nullPut in interface XPuttingCollection<KeyValue<K,V>>public final boolean isFull()
isFull in interface CapacityCarryingpublic final boolean nullValuesAllowed()
nullValuesAllowed in interface XAddingMap<K,V>nullValuesAllowed in interface XGettingMap<K,V>nullValuesAllowed in interface XMap<K,V>public final long currentCapacity()
CapacityExtendable
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().
currentCapacity in interface CapacityExtendablepublic final KeyValue<K,V> get()
XGettingCollectionXGettingSequence, then it is
undefined which element is returned. If the collection is ordered, the element at index 0 is returned.get in interface XGettingCollection<KeyValue<K,V>>public final boolean add(K key, V value)
XMappublic final KeyValue<K,V> fetch()
fetch in interface XProcessingCollection<KeyValue<K,V>>public final XGettingMap<K,V> view()
XGettingCollection
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.
view in interface XGettingCollection<KeyValue<K,V>>view in interface XGettingMap<K,V>public final KeyValue<K,V> pinch()
pinch in interface XProcessingCollection<KeyValue<K,V>>public final boolean put(K key, V value)
XMappublic final Object[] toArray()
XGettingCollectionThe 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.
toArray in interface XGettingCollection<KeyValue<K,V>>public final KeyValue<K,V>[] toArray(Class<KeyValue<K,V>> type)
XGettingCollectionThe 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.
public final KeyValue<K,V> retrieve(KeyValue<K,V> element)
retrieve in interface XProcessingCollection<KeyValue<K,V>>public final KeyValue<K,V> retrieveBy(Predicate<? super KeyValue<K,V>> predicate)
retrieveBy in interface XProcessingCollection<KeyValue<K,V>>public final long currentFreeCapacity()
currentFreeCapacity in interface CapacityExtendablepublic final boolean set(K key, V value)
XMappublic final long removeDuplicates(Equalator<? super KeyValue<K,V>> equalator)
removeDuplicates in interface XProcessingCollection<KeyValue<K,V>>public final long removeBy(Predicate<? super KeyValue<K,V>> predicate)
removeBy in interface XProcessingCollection<KeyValue<K,V>>public final boolean add(KeyValue<K,V> element)
XAddingCollectionadd in interface XAddingCollection<KeyValue<K,V>>element - to addtrue if element was added; false if notpublic final <C extends Consumer<? super KeyValue<K,V>>> C moveTo(C target, Predicate<? super KeyValue<K,V>> predicate)
moveTo in interface XProcessingCollection<KeyValue<K,V>>public final boolean nullAdd()
nullAdd in interface XAddingCollection<KeyValue<K,V>>public final KeyValue<K,V> putGet(K key, V value)
XMappublic final KeyValue<K,V> setGet(K key, V value)
XMappublic final Spliterator<KeyValue<K,V>> spliterator()
spliterator in interface Iterable<KeyValue<K,V>>public final boolean valuePut(K sampleKey, V value)
XMappublic final long size()
public final Equalator<? super KeyValue<K,V>> equality()
equality in interface XGettingCollection<KeyValue<K,V>>public final boolean equals(XGettingCollection<? extends KeyValue<K,V>> samples, Equalator<? super KeyValue<K,V>> equalator)
equals in interface XGettingCollection<KeyValue<K,V>>samples - is the collection which is checked for equalityequalator - is used to check the equality of the collectionstrue if the passed collection is of the same type as this collection and
this.equalsContent(list, equalator) yields truepublic final boolean valueSet(K sampleKey, V value)
XMappublic final long nullRemove()
nullRemove in interface XRemovingCollection<KeyValue<K,V>>public final boolean removeOne(KeyValue<K,V> element)
removeOne in interface XRemovingCollection<KeyValue<K,V>>public final V valuePutGet(K sampleKey, V value)
XMapvaluePutGet in interface XMap<K,V>sampleKey - to find the an existing elementvalue - to addpublic final boolean equalsContent(XGettingCollection<? extends KeyValue<K,V>> samples, Equalator<? super KeyValue<K,V>> equalator)
XGettingCollectiontrue 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 in Collection). The core problem of comparing
collections that have no defined order is that they aren't really reliably comparable to any other collection.
equalsContent in interface XGettingCollection<KeyValue<K,V>>samples - is the collection which is checked for equalityequalator - the equalator to use to determine the equality of each elementtrue if this list is equal to the passed list, false otherwisepublic final long remove(KeyValue<K,V> element)
remove in interface XRemovingCollection<KeyValue<K,V>>public final long removeAll(XGettingCollection<? extends KeyValue<K,V>> elements)
removeAll in interface XRemovingCollection<KeyValue<K,V>>public final V valueSetGet(K sampleKey, V value)
XMapvalueSetGet in interface XMap<K,V>sampleKey - to find the an existing elementvalue - to addpublic final long retainAll(XGettingCollection<? extends KeyValue<K,V>> elements)
XRemovingCollectionBasically intersect this collection with the given collection and only keeping the resulting elements.
retainAll in interface XRemovingCollection<KeyValue<K,V>>elements - to retainpublic final long removeDuplicates()
removeDuplicates in interface XRemovingCollection<KeyValue<K,V>>public final V searchValue(Predicate<? super K> keyPredicate)
searchValue in interface XGettingMap<K,V>searchValue in interface XMap<K,V>public final XImmutableMap<K,V> immure()
XGettingMapIf this instance already is of an immutable collection type, it returns itself.
immure in interface XGettingCollection<KeyValue<K,V>>immure in interface XGettingMap<K,V>immure in interface XGettingSet<KeyValue<K,V>>immure in interface XMap<K,V>immure in interface XProcessingSet<KeyValue<K,V>>@SafeVarargs public final XMap<K,V> putAll(KeyValue<K,V>... elements)
XMapputAll in interface XCollection<KeyValue<K,V>>putAll in interface XMap<K,V>putAll in interface XPutGetCollection<KeyValue<K,V>>putAll in interface XPutGetSet<KeyValue<K,V>>putAll in interface XPuttingCollection<KeyValue<K,V>>putAll in interface XPuttingSet<KeyValue<K,V>>putAll in interface XSet<KeyValue<K,V>>elements - to addpublic final XMap<K,V> putAll(KeyValue<K,V>[] elements, int srcStartIndex, int srcLength)
XMapputAll in interface XCollection<KeyValue<K,V>>putAll in interface XMap<K,V>putAll in interface XPutGetCollection<KeyValue<K,V>>putAll in interface XPutGetSet<KeyValue<K,V>>putAll in interface XPuttingCollection<KeyValue<K,V>>putAll in interface XPuttingSet<KeyValue<K,V>>putAll in interface XSet<KeyValue<K,V>>elements - to addsrcStartIndex - start index of elements-array to add to collectionsrcLength - length of elements-array to add to collection@SafeVarargs public final XMap<K,V> addAll(KeyValue<K,V>... elements)
addAll in interface XAddGetCollection<KeyValue<K,V>>addAll in interface XAddGetSet<KeyValue<K,V>>addAll in interface XAddingCollection<KeyValue<K,V>>addAll in interface XAddingSet<KeyValue<K,V>>addAll in interface XCollection<KeyValue<K,V>>addAll in interface XMap<K,V>addAll in interface XPutGetCollection<KeyValue<K,V>>addAll in interface XPutGetSet<KeyValue<K,V>>addAll in interface XPuttingSet<KeyValue<K,V>>addAll in interface XSet<KeyValue<K,V>>public final XMap<K,V> addAll(KeyValue<K,V>[] elements, int srcStartIndex, int srcLength)
addAll in interface XAddGetCollection<KeyValue<K,V>>addAll in interface XAddGetSet<KeyValue<K,V>>addAll in interface XAddingCollection<KeyValue<K,V>>addAll in interface XAddingSet<KeyValue<K,V>>addAll in interface XCollection<KeyValue<K,V>>addAll in interface XMap<K,V>addAll in interface XPutGetCollection<KeyValue<K,V>>addAll in interface XPutGetSet<KeyValue<K,V>>addAll in interface XPuttingSet<KeyValue<K,V>>addAll in interface XSet<KeyValue<K,V>>public final XMap<K,V> addAll(XGettingCollection<? extends KeyValue<K,V>> elements)
addAll in interface XAddGetCollection<KeyValue<K,V>>addAll in interface XAddGetSet<KeyValue<K,V>>addAll in interface XAddingCollection<KeyValue<K,V>>addAll in interface XAddingSet<KeyValue<K,V>>addAll in interface XCollection<KeyValue<K,V>>addAll in interface XMap<K,V>addAll in interface XPutGetCollection<KeyValue<K,V>>addAll in interface XPutGetSet<KeyValue<K,V>>addAll in interface XPuttingSet<KeyValue<K,V>>addAll in interface XSet<KeyValue<K,V>>public final boolean nullContained()
nullContained in interface XGettingCollection<KeyValue<K,V>>public final boolean containsId(KeyValue<K,V> element)
XGettingCollectionXGettingCollection.containsSearched(Predicate) with a Predicate implementation
that checks for object identity. The only difference is a performance and usability advantagecontainsId in interface XGettingCollection<KeyValue<K,V>>element - the element to be searched in the collection by identity.public final boolean contains(KeyValue<K,V> element)
XGettingCollectionXGettingCollection.containsId(Object) method, this method
uses the internal Equalator defined by the collection itself.public final boolean containsSearched(Predicate<? super KeyValue<K,V>> predicate)
containsSearched in interface XGettingCollection<KeyValue<K,V>>public final boolean containsAll(XGettingCollection<? extends KeyValue<K,V>> elements)
containsAll in interface XGettingCollection<KeyValue<K,V>>elements - to be searched in the collection.Equalator.public final boolean applies(Predicate<? super KeyValue<K,V>> predicate)
XGettingCollectionapplies in interface XGettingCollection<KeyValue<K,V>>predicate - that's tested on each element.public final long count(KeyValue<K,V> element)
XGettingCollectionEqualator.count in interface XGettingCollection<KeyValue<K,V>>element - to countpublic final long countBy(Predicate<? super KeyValue<K,V>> predicate)
XGettingCollectioncountBy in interface XGettingCollection<KeyValue<K,V>>predicate - defines which elements are counted and which are notpublic final KeyValue<K,V> search(Predicate<? super KeyValue<K,V>> predicate)
XGettingCollectionsearch in interface XGettingCollection<KeyValue<K,V>>predicate - defines which element is searchedpublic final KeyValue<K,V> seek(KeyValue<K,V> sample)
XGettingCollectionXGettingCollection.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)seek in interface XGettingCollection<KeyValue<K,V>>sample - to seek in the collectionpublic final KeyValue<K,V> max(Comparator<? super KeyValue<K,V>> comparator)
max in interface XGettingCollection<KeyValue<K,V>>public final KeyValue<K,V> min(Comparator<? super KeyValue<K,V>> comparator)
min in interface XGettingCollection<KeyValue<K,V>>public final <T extends Consumer<? super KeyValue<K,V>>> T distinct(T target)
XGettingCollectionConsumer.accept(Object) on the target Consumer for all the unique/distinct
elements of this collection. This means the elements are not equal to each other.Equalator.
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 in distinctCollection containing 1, 2 and 3.
distinct in interface XGettingCollection<KeyValue<K,V>>T - type of the targettarget - on which the Consumer.accept(Object) is called for every distinct element of this collection.public final <T extends Consumer<? super KeyValue<K,V>>> T distinct(T target, Equalator<? super KeyValue<K,V>> equalator)
XGettingCollectionConsumer.accept(Object) on the target Consumer for all the unique/distinct
elements of this collection. This means the elements are not equal to each other.Equalator.
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 in
distinctCollection containing 1, 2 and 3.distinct in interface XGettingCollection<KeyValue<K,V>>T - type of the targettarget - on which the Consumer.accept(Object) is called for every distinct element of this collection.equalator - defines what distinct means (which elements are equal to one another)public final <T extends Consumer<? super KeyValue<K,V>>> T copyTo(T target)
XGettingCollectionConsumer.accept(Object) on the target Consumer 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 in
copiedCollection containing 1, 2 and 3.copyTo in interface XGettingCollection<KeyValue<K,V>>T - type of the targettarget - on which the Consumer.accept(Object) is called for all elements of this collection.public final <T extends Consumer<? super KeyValue<K,V>>> T filterTo(T target, Predicate<? super KeyValue<K,V>> predicate)
XGettingCollectionConsumer.accept(Object) on the target Consumer for all the elements of this collection
which test true 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 in
filteredCollection containing 2.filterTo in interface XGettingCollection<KeyValue<K,V>>T - type of the targettarget - on which the Consumer.accept(Object) is called for elements that test true.predicate - on which to test all elements.public final <T extends Consumer<? super KeyValue<K,V>>> T union(XGettingCollection<? extends KeyValue<K,V>> other, Equalator<? super KeyValue<K,V>> equalator, T target)
XGettingCollectionConsumer.accept(Object) on the target Consumer 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 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> union = collection1.union(collection2, Equalator.identity(), BulkList.New());Results in
union containing 1, 2, 3 and 4.union in interface XGettingCollection<KeyValue<K,V>>T - type of the targetother - collection to build a union with.equalator - which is used for the equal-tests.target - on which the Consumer.accept(Object) is called for all unified elements.public final <T extends Consumer<? super KeyValue<K,V>>> T intersect(XGettingCollection<? extends KeyValue<K,V>> other, Equalator<? super KeyValue<K,V>> equalator, T target)
XGettingCollectionConsumer.accept(Object) on the target Consumer for the
equal elements.
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 in
intersection containing 2 and 3.intersect in interface XGettingCollection<KeyValue<K,V>>T - type of the targetother - collection to intersect with.equalator - which is used for the equal-tests.target - on which the Consumer.accept(Object) is called for equal elements.public final <T extends Consumer<? super KeyValue<K,V>>> T except(XGettingCollection<? extends KeyValue<K,V>> other, Equalator<? super KeyValue<K,V>> equalator, T target)
XGettingCollectionConsumer.accept(Object) on the target Consumer 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 in
exceptCollection containing 1.except in interface XGettingCollection<KeyValue<K,V>>T - type of the targetother - collection whose elements are excluded from the target.equalator - which is used for the equal-tests.target - on which the Consumer.accept(Object) is called for elements not contained in the other collection.@Deprecated public final boolean equals(Object o)
XGettingCollectionCollection.
Note that it is this interface's author opinion that the whole concept of equals() in standard Java, especially
in the collection implementations, is flawed.
The reason is because all different kinds of comparison types that actually depend on the situation
have to be mixed up in a harcoded fashion in one method, from identity comparison over
data indentity comparison to content comparison.
In order to get the right behavior in every situation, one has to distinct between different types of equality
This means several things:
1.) You can't just say for example an ArrayList is the "same" as a LinkedList just because they contain the
same content.
There are different implementations for a good reason, so you have to distinct them when comparing.
There are simple code examples which create massive misbehavior that will catastrophically ruin the runtime
behavior of a programm due to this error in Java / JDK / Sun / whatever.
2.) You can't always determine equality of two collections by determining equality of each element as
Collection defines it.
As a conclusion: don't use this method!
Be clear what type of comparison you really need, then use one of the following methods
and proper comparators:
XGettingCollection.equals(XGettingCollection, Equalator)
XGettingCollection.equalsContent(XGettingCollection, Equalator)
@Deprecated public final int hashCode()
Copyright © 2022 MicroStream Software. All rights reserved.