E - type of contained elementspublic final class OpenAdressingMiniSet<E> extends Object implements XSet<E>
XSet implementation.
It is considerable faster than general purpose hash collections like HashEnum, which use
chains instead of open adressing for resolving hash collisions. It also scales much better with higher element count.
XSet.Factory<E>XPuttingSet.Creator<E>XPutGetCollection.Creator<E>XIterable.Executor<E>Copyable.Static| Modifier and Type | Method and Description |
|---|---|
void |
accept(E t) |
boolean |
add(E element)
Adds the passed element.
|
XSet<E> |
addAll(E... elements) |
XSet<E> |
addAll(E[] elements,
int srcStartIndex,
int srcLength) |
XSet<E> |
addAll(XGettingCollection<? extends E> elements) |
E |
addGet(E element) |
boolean |
applies(Predicate<? super E> 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.
|
long |
consolidate()
Consolidates the internal storage of this collection by discarding all elements of the internal storage that
have become obsolete or otherwise unneeded anymore.
|
boolean |
contains(E element)
Checks if the given element is contained in the collection.
|
boolean |
containsAll(XGettingCollection<? extends E> elements) |
boolean |
containsId(E element)
Special version of contains() that guarantees to use identity comparison (" == ") when searching for the
given element regardless of the collection's internal logic.
This method has the same behavior as XGettingCollection.containsSearched(Predicate) with a Predicate implementation
that checks for object identity. |
boolean |
containsSearched(Predicate<? super E> predicate) |
XSet<E> |
copy()
Creates a true copy of this collection which references the same elements as this collection does
at the time the method is called.
|
<T extends Consumer<? super E>> |
copyTo(T target)
Calls
Consumer.accept(Object) on the target Consumer for all the elements of this collection. |
long |
count(E element)
Count how many times this element matches another element in the collection
using the
Equalator. |
long |
countBy(Predicate<? super E> predicate)
Count how many matches are found using the given predicate on each element of the collection.
|
long |
currentCapacity()
Returns the current amount of elements this instance can hold before a storage rebuild becomes necessary.
|
E |
deduplicate(E element) |
<T extends Consumer<? super E>> |
distinct(T target)
Calls
Consumer.accept(Object) on the target Consumer for all the unique/distinct
elements of this collection. |
<T extends Consumer<? super E>> |
distinct(T target,
Equalator<? super E> equalator)
Calls
Consumer.accept(Object) on the target Consumer for all the unique/distinct
elements of this collection. |
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 E> |
equality() |
boolean |
equals(XGettingCollection<? extends E> samples,
Equalator<? super E> equalator) |
boolean |
equalsContent(XGettingCollection<? extends E> samples,
Equalator<? super E> 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 E>> |
except(XGettingCollection<? extends E> other,
Equalator<? super E> 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). |
E |
fetch() |
<T extends Consumer<? super E>> |
filterTo(T target,
Predicate<? super E> predicate)
Calls
Consumer.accept(Object) on the target Consumer for all the elements of this collection
which test true on the given predicate. |
E |
get()
Gets one element from the collection.
|
boolean |
hasVolatileElements()
Tells if this collection contains volatile elements.
An element is volatile, if it can become no longer reachable by the collection without being removed from the collection. |
XImmutableSet<E> |
immure()
Provides an instance of an immutable collection type with equal behavior and data as this instance.
|
<T extends Consumer<? super E>> |
intersect(XGettingCollection<? extends E> other,
Equalator<? super E> 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. |
<P extends Consumer<? super E>> |
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<E> |
iterator() |
E |
max(Comparator<? super E> comparator) |
long |
maximumCapacity()
Returns the maximum amount of elements this carrier instance can contain.
The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g. |
E |
min(Comparator<? super E> comparator) |
<C extends Consumer<? super E>> |
moveTo(C target,
Predicate<? super E> predicate) |
static <E> OpenAdressingMiniSet<E> |
New() |
static <E> OpenAdressingMiniSet<E> |
New(int initialCapacity) |
static <E> OpenAdressingMiniSet<E> |
New(XGettingCollection<? extends E> elements) |
boolean |
nullAdd() |
boolean |
nullAllowed()
Defines if null-elements are allowed inside the collection or not.
|
boolean |
nullContained() |
boolean |
nullPut() |
long |
nullRemove() |
OldCollection<E> |
old() |
long |
optimize()
Optimizes the internal storage of this collection and returns the storage size of the collection after the
process is complete.
|
E |
pinch() |
<P extends Consumer<? super E>> |
process(P processor) |
boolean |
put(E element)
Adds the specified element to this collection if it is not already present (optional operation).
|
XSet<E> |
putAll(E... elements)
Adds the specified elements to this collection if it is not already present (optional operation).
|
XSet<E> |
putAll(E[] elements,
int srcStartIndex,
int srcLength)
Adds the specified elements to this collection if it is not already present (optional operation).
Only the elements with indizes from the srcStartIndex to the srcStartIndex+srcLength are put in the collection. |
XSet<E> |
putAll(XGettingCollection<? extends E> elements)
Adds the specified elements to this collection if it is not already present (optional operation).
|
E |
putGet(E element) |
long |
remove(E element) |
long |
removeAll(XGettingCollection<? extends E> elements) |
long |
removeBy(Predicate<? super E> predicate) |
long |
removeDuplicates() |
long |
removeDuplicates(Equalator<? super E> equalator) |
boolean |
removeOne(E element) |
E |
replace(E element) |
long |
retainAll(XGettingCollection<? extends E> elements)
Removing all elements except the ones contained in the given elements-collection.
|
E |
retrieve(E element) |
E |
retrieveBy(Predicate<? super E> predicate) |
E |
search(Predicate<? super E> predicate)
Returns the first contained element matching the passed predicate.
|
E |
seek(E sample)
Returns the first contained element matching the passed sample as defined by the collection's equality logic
or null, if no fitting element is contained.
|
long |
size() |
Object[] |
toArray()
Returns an array containing all of the elements in this collection.
|
E[] |
toArray(Class<E> type)
Returns a typed array containing all of the elements in this collection.
|
String |
toString() |
void |
truncate()
Clears (and reinitializes if needed) this collection in the fastest possible way, i.e.
|
<T extends Consumer<? super E>> |
union(XGettingCollection<? extends E> other,
Equalator<? super E> equalator,
T target)
Calls
Consumer.accept(Object) on the target Consumer for all the elements of this collection. |
XGettingCollection<E> |
view()
Creates a view of this collection and returns it.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitcollectorequals, hashCode, intSize, joinforEach, spliteratorcurrentFreeCapacityisFull, remainingCapacitypublic static <E> OpenAdressingMiniSet<E> New()
public static <E> OpenAdressingMiniSet<E> New(int initialCapacity)
public static <E> OpenAdressingMiniSet<E> New(XGettingCollection<? extends E> elements)
public final boolean add(E element)
XAddingCollectionadd in interface XAddingCollection<E>element - to addtrue if element was added; false if notpublic long size()
size in interface Sizedsize in interface XGettingCollection<E>public E 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<E>public 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<E>public E[] toArray(Class<E> 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.
toArray in interface XGettingCollection<E>type - the Class representing type E at runtime.public OldCollection<E> old()
old in interface XGettingCollection<E>public 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<E>hasVolatileElements in interface XGettingCollection<E>true if the collection contains volatile elements.public Equalator<? super E> equality()
equality in interface XGettingCollection<E>public boolean equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
equals in interface XGettingCollection<E>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 boolean equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> 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<E>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 XGettingCollection<E> 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<E>public boolean nullContained()
nullContained in interface XGettingCollection<E>public boolean containsId(E 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<E>element - the element to be searched in the collection by identity.public boolean contains(E element)
XGettingCollectionXGettingCollection.containsId(Object) method, this method
uses the internal Equalator defined by the collection itself.contains in interface XGettingCollection<E>element - to be searched in the collectionEqualator.public boolean containsSearched(Predicate<? super E> predicate)
containsSearched in interface XGettingCollection<E>public boolean containsAll(XGettingCollection<? extends E> elements)
containsAll in interface XGettingCollection<E>elements - to be searched in the collection.Equalator.public boolean applies(Predicate<? super E> predicate)
XGettingCollectionapplies in interface XGettingCollection<E>predicate - that's tested on each element.public long count(E element)
XGettingCollectionEqualator.count in interface XGettingCollection<E>element - to countpublic long countBy(Predicate<? super E> predicate)
XGettingCollectioncountBy in interface XGettingCollection<E>predicate - defines which elements are counted and which are notpublic E search(Predicate<? super E> predicate)
XGettingCollectionsearch in interface XGettingCollection<E>predicate - defines which element is searchedpublic E seek(E 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<E>sample - to seek in the collectionpublic E max(Comparator<? super E> comparator)
max in interface XGettingCollection<E>public E min(Comparator<? super E> comparator)
min in interface XGettingCollection<E>public <T extends Consumer<? super E>> 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<E>T - type of the targettarget - on which the Consumer.accept(Object) is called for every distinct element of this collection.public <T extends Consumer<? super E>> T distinct(T target, Equalator<? super E> 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<E>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 <T extends Consumer<? super E>> 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<E>T - type of the targettarget - on which the Consumer.accept(Object) is called for all elements of this collection.public <T extends Consumer<? super E>> T filterTo(T target, Predicate<? super E> 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<E>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 <T extends Consumer<? super E>> T union(XGettingCollection<? extends E> other, Equalator<? super E> 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<E>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 <T extends Consumer<? super E>> T intersect(XGettingCollection<? extends E> other, Equalator<? super E> 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<E>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 <T extends Consumer<? super E>> T except(XGettingCollection<? extends E> other, Equalator<? super E> 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<E>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.public <P extends Consumer<? super E>> 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<E>iterate in interface XIterable<E>iterate in interface XProcessingCollection<E>P - type of procedureprocedure - The procedure to be performed for each elementpublic boolean nullAllowed()
ExtendedCollectionnullAllowed in interface ExtendedCollection<E>true if null is allowed inside the collection; false if notpublic long maximumCapacity()
CapacityCarryingInteger.MAX_VALUE)maximumCapacity in interface CapacityCarryingpublic boolean nullAdd()
nullAdd in interface XAddingCollection<E>public CapacityExtendable ensureCapacity(long minimalCapacity)
ensureCapacity in interface CapacityExtendablepublic CapacityExtendable ensureFreeCapacity(long minimalFreeCapacity)
CapacityExtendableensureFreeCapacity in interface CapacityExtendableminimalFreeCapacity - the capacity to ensurepublic 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 long optimize()
OptimizableCollectionoptimize in interface OptimizableCollectionoptimize in interface XRemovingCollection<E>public void accept(E t)
public boolean put(E element)
XPuttingCollectionput in interface XPuttingCollection<E>element - to addpublic boolean nullPut()
nullPut in interface XPuttingCollection<E>public E fetch()
fetch in interface XProcessingCollection<E>public E pinch()
pinch in interface XProcessingCollection<E>public E retrieve(E element)
retrieve in interface XProcessingCollection<E>public E retrieveBy(Predicate<? super E> predicate)
retrieveBy in interface XProcessingCollection<E>public long removeDuplicates(Equalator<? super E> equalator)
removeDuplicates in interface XProcessingCollection<E>public long removeBy(Predicate<? super E> predicate)
removeBy in interface XProcessingCollection<E>public <C extends Consumer<? super E>> C moveTo(C target, Predicate<? super E> predicate)
moveTo in interface XProcessingCollection<E>public <P extends Consumer<? super E>> P process(P processor)
process in interface Processable<E>public void clear()
XRemovingCollectionclear in interface XRemovingCollection<E>clear in interface Clearablepublic void truncate()
XRemovingCollectiontruncate in interface Truncateabletruncate in interface XRemovingCollection<E>public long consolidate()
ConsolidatableCollectionWeakReference entries whose reference has
been cleared).consolidate in interface ConsolidatableCollectionconsolidate in interface XRemovingCollection<E>public long nullRemove()
nullRemove in interface XRemovingCollection<E>public boolean removeOne(E element)
removeOne in interface XRemovingCollection<E>public long remove(E element)
remove in interface XRemovingCollection<E>public long removeAll(XGettingCollection<? extends E> elements)
removeAll in interface XRemovingCollection<E>public long retainAll(XGettingCollection<? extends E> elements)
XRemovingCollectionBasically intersect this collection with the given collection and only keeping the resulting elements.
retainAll in interface XRemovingCollection<E>elements - to retainpublic long removeDuplicates()
removeDuplicates in interface XRemovingCollection<E>public E addGet(E element)
addGet in interface XAddGetSet<E>public E deduplicate(E element)
deduplicate in interface XAddGetSet<E>public E putGet(E element)
putGet in interface XPutGetSet<E>public E replace(E element)
replace in interface XPutGetSet<E>public XImmutableSet<E> immure()
XGettingCollectionIf this instance already is of an immutable collection type, it returns itself.
immure in interface XGettingCollection<E>immure in interface XGettingSet<E>immure in interface XProcessingSet<E>@SafeVarargs public final XSet<E> putAll(E... elements)
XPuttingCollectionputAll in interface XCollection<E>putAll in interface XPutGetCollection<E>putAll in interface XPutGetSet<E>putAll in interface XPuttingCollection<E>putAll in interface XPuttingSet<E>putAll in interface XSet<E>elements - to addpublic XSet<E> putAll(E[] elements, int srcStartIndex, int srcLength)
XPuttingCollectionputAll in interface XCollection<E>putAll in interface XPutGetCollection<E>putAll in interface XPutGetSet<E>putAll in interface XPuttingCollection<E>putAll in interface XPuttingSet<E>putAll in interface XSet<E>elements - to addsrcStartIndex - start index of elements-array to add to collectionsrcLength - length of elements-array to add to collectionpublic XSet<E> putAll(XGettingCollection<? extends E> elements)
XPuttingCollectionputAll in interface XCollection<E>putAll in interface XPutGetCollection<E>putAll in interface XPutGetSet<E>putAll in interface XPuttingCollection<E>putAll in interface XPuttingSet<E>putAll in interface XSet<E>elements - to add@SafeVarargs public final XSet<E> addAll(E... elements)
addAll in interface XAddGetCollection<E>addAll in interface XAddGetSet<E>addAll in interface XAddingCollection<E>addAll in interface XAddingSet<E>addAll in interface XCollection<E>addAll in interface XPutGetCollection<E>addAll in interface XPutGetSet<E>addAll in interface XPuttingSet<E>addAll in interface XSet<E>public XSet<E> addAll(E[] elements, int srcStartIndex, int srcLength)
addAll in interface XAddGetCollection<E>addAll in interface XAddGetSet<E>addAll in interface XAddingCollection<E>addAll in interface XAddingSet<E>addAll in interface XCollection<E>addAll in interface XPutGetCollection<E>addAll in interface XPutGetSet<E>addAll in interface XPuttingSet<E>addAll in interface XSet<E>public XSet<E> addAll(XGettingCollection<? extends E> elements)
addAll in interface XAddGetCollection<E>addAll in interface XAddGetSet<E>addAll in interface XAddingCollection<E>addAll in interface XAddingSet<E>addAll in interface XCollection<E>addAll in interface XPutGetCollection<E>addAll in interface XPutGetSet<E>addAll in interface XPuttingSet<E>addAll in interface XSet<E>public XSet<E> copy()
XGettingCollectioncopy in interface XAddGetCollection<E>copy in interface XAddGetSet<E>copy in interface XCollection<E>copy in interface XGettingCollection<E>copy in interface XGettingSet<E>copy in interface XProcessingSet<E>copy in interface XPutGetCollection<E>copy in interface XPutGetSet<E>copy in interface XSet<E>copy in interface CopyableCopyright © 2022 MicroStream Software. All rights reserved.