Class LockedCollection<E>
- All Implemented Interfaces:
Iterable<E>
,Consumer<E>
,CapacityCarrying
,CapacityExtendable
,ConsolidatableCollection
,ExtendedCollection<E>
,OptimizableCollection
,ReleasingCollection<E>
,Sized
,Truncateable
,XAddGetCollection<E>
,XAddingCollection<E>
,XCollection<E>
,XGettingCollection<E>
,XIterable<E>
,XJoinable<E>
,XProcessingCollection<E>
,XPutGetCollection<E>
,XPuttingCollection<E>
,XRemovingCollection<E>
,Synchronized
,ThreadSafe
,Processable<E>
,Clearable
,Copyable
public final class LockedCollection<E> extends Object implements XCollection<E>, Synchronized
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
LockedCollection.OldMutexCollection<E>
Nested classes/interfaces inherited from interface one.microstream.collections.interfaces.ExtendedCollection
ExtendedCollection.Creator<E,C extends ExtendedCollection<E>>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XCollection
XCollection.Factory<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingCollection
XGettingCollection.Creator<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XIterable
XIterable.Executor<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XPutGetCollection
XPutGetCollection.Creator<E>
-
Constructor Summary
Constructors Constructor Description LockedCollection(XCollection<E> collection)
LockedCollection(XCollection<E> collection, Object lock)
-
Method Summary
Modifier and Type Method Description void
accept(E e)
boolean
add(E e)
Adds the passed element.LockedCollection<E>
addAll(E... elements)
LockedCollection<E>
addAll(E[] elements, int offset, int length)
LockedCollection<E>
addAll(XGettingCollection<? extends E> elements)
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 asXGettingCollection.containsSearched(Predicate)
with aPredicate
implementation that checks for object identity.boolean
containsSearched(Predicate<? super E> predicate)
LockedCollection<E>
copy()
Creates a true copy of this collection which references the same elements as this collection does at the time the method is called.<C extends Consumer<? super E>>
CcopyTo(C target)
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection.long
count(E element)
Count how many times this element matches another element in the collection using theEqualator
.long
countBy(Predicate<? super E> predicate)
Count how many matches are found using the given predicate on each element of the collection.long
currentCapacity()
Returns the current amount of elements this instance can hold before a storage rebuild becomes necessary.<C extends Consumer<? super E>>
Cdistinct(C target)
CallsConsumer.accept(Object)
on the targetConsumer
for all the unique/distinct elements of this collection.<C extends Consumer<? super E>>
Cdistinct(C target, Equalator<? super E> equalator)
CallsConsumer.accept(Object)
on the targetConsumer
for all the unique/distinct elements of this collection.LockedCollection<E>
ensureCapacity(long minimalCapacity)
LockedCollection<E>
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(Object o)
Deprecated.boolean
equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
boolean
equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
Returnstrue
if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.<C extends Consumer<? super E>>
Cexcept(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)
CallsConsumer.accept(Object)
on the targetConsumer
for each element of this collection that is not contained in the other collection (through the given equalator).E
fetch()
<C extends Consumer<? super E>>
CfilterTo(C target, Predicate<? super E> predicate)
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection which testtrue
on the given predicate.E
get()
Gets one element from the collection.int
hashCode()
Deprecated.boolean
hasVolatileElements()
Tells if this collection contains volatile elements.
An element is volatile, if it can become no longer reachable by the collection without being removed from the collection.XImmutableCollection<E>
immure()
Provides an instance of an immutable collection type with equal behavior and data as this instance.<C extends Consumer<? super E>>
Cintersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)
Tests equality between each element of the two lists and callsConsumer.accept(Object)
on the targetConsumer
for the equal elements.
Therefore it effectively creates a mathematical intersection between the two collections.boolean
isEmpty()
boolean
isFull()
Returns true if the current capacity cannot be increased any more.<P extends Consumer<? super E>>
Piterate(P procedure)
Executes the given procedure for each element of theXIterable
until all elements have been processed or the action throws an exception.Iterator<E>
iterator()
<A> A
join(BiConsumer<? super E,? super A> joiner, A aggregate)
Iterates over all elements of the collections and calls the joiner with each element and the aggregate.E
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>>
CmoveTo(C target, Predicate<? super E> predicate)
boolean
nullAdd()
boolean
nullAllowed()
Defines if null-elements are allowed inside the collection or not.boolean
nullContained()
boolean
nullPut()
long
nullRemove()
LockedCollection.OldMutexCollection<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>>
Pprocess(P procedure)
boolean
put(E e)
Adds the specified element to this collection if it is not already present (optional operation).LockedCollection<E>
putAll(E... elements)
Adds the specified elements to this collection if it is not already present (optional operation).LockedCollection<E>
putAll(E[] elements, int offset, int length)
Adds the specified elements to this collection if it is not already present (optional operation).
Only the elements with indizes from the srcStartIndex to the srcStartIndex+srcLength are put in the collection.LockedCollection<E>
putAll(XGettingCollection<? extends E> elements)
Adds the specified elements to this collection if it is not already present (optional operation).long
remainingCapacity()
Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.long
remove(E element)
long
removeAll(XGettingCollection<? extends E> samples)
long
removeBy(Predicate<? super E> predicate)
long
removeDuplicates()
long
removeDuplicates(Equalator<? super E> equalator)
boolean
removeOne(E element)
long
retainAll(XGettingCollection<? extends E> samples)
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.void
truncate()
Clears (and reinitializes if needed) this collection in the fastest possible way, i.e.<C extends Consumer<? super E>>
Cunion(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection.View<E>
view()
Creates a view of this collection and returns it.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface one.microstream.collections.interfaces.CapacityExtendable
currentFreeCapacity
-
Constructor Details
-
Method Details
-
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<E>
- Returns:
- the first / any element.
-
equality
- Specified by:
equality
in interfaceXGettingCollection<E>
-
addAll
- Specified by:
addAll
in interfaceXAddGetCollection<E>
- Specified by:
addAll
in interfaceXAddingCollection<E>
- Specified by:
addAll
in interfaceXCollection<E>
- Specified by:
addAll
in interfaceXPutGetCollection<E>
-
nullAdd
public final boolean nullAdd()- Specified by:
nullAdd
in interfaceXAddingCollection<E>
-
add
Description copied from interface:XAddingCollection
Adds the passed element.- Specified by:
add
in interfaceXAddingCollection<E>
- Parameters:
e
- to add- Returns:
true
if element was added;false
if not
-
addAll
- Specified by:
addAll
in interfaceXAddGetCollection<E>
- Specified by:
addAll
in interfaceXAddingCollection<E>
- Specified by:
addAll
in interfaceXCollection<E>
- Specified by:
addAll
in interfaceXPutGetCollection<E>
-
addAll
- Specified by:
addAll
in interfaceXAddGetCollection<E>
- Specified by:
addAll
in interfaceXAddingCollection<E>
- Specified by:
addAll
in interfaceXCollection<E>
- Specified by:
addAll
in interfaceXPutGetCollection<E>
-
nullPut
public final boolean nullPut()- Specified by:
nullPut
in interfaceXPuttingCollection<E>
-
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<E>
- Parameters:
e
- to add- Returns:
- true if this collection did not already contain the specified element
-
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 interfaceXCollection<E>
- Specified by:
putAll
in interfaceXPutGetCollection<E>
- Specified by:
putAll
in interfaceXPuttingCollection<E>
- Parameters:
elements
- to add- Returns:
- this
-
putAll
Description copied from interface:XPuttingCollection
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.- Specified by:
putAll
in interfaceXCollection<E>
- Specified by:
putAll
in interfaceXPutGetCollection<E>
- Specified by:
putAll
in interfaceXPuttingCollection<E>
- Parameters:
elements
- to addoffset
- start index of elements-array to add to collectionlength
- length of elements-array to add to collection- Returns:
- this
-
putAll
Description copied from interface:XPuttingCollection
Adds the specified elements to this collection if it is not already present (optional operation).- Specified by:
putAll
in interfaceXCollection<E>
- Specified by:
putAll
in interfaceXPutGetCollection<E>
- Specified by:
putAll
in interfaceXPuttingCollection<E>
- Parameters:
elements
- to add- Returns:
- this
-
containsSearched
- Specified by:
containsSearched
in interfaceXGettingCollection<E>
-
applies
Description copied from interface:XGettingCollection
Tests each element of the collection on the given predicate.- Specified by:
applies
in interfaceXGettingCollection<E>
- Parameters:
predicate
- that's tested on each element.- Returns:
- If all elements test successfully, true is returned. Otherwise (if at least one test has failed), false is returned.
-
clear
public final void clear()Description copied from interface:XRemovingCollection
Clears all elements from the collection while leaving the capacity as it is.- Specified by:
clear
in interfaceClearable
- Specified by:
clear
in interfaceXRemovingCollection<E>
-
consolidate
public final long consolidate()Description copied from interface:ConsolidatableCollection
Consolidates the internal storage of this collection by discarding all elements of the internal storage that have become obsolete or otherwise unneeded anymore. (e.g.WeakReference
entries whose reference has been cleared).- Specified by:
consolidate
in interfaceConsolidatableCollection
- Specified by:
consolidate
in interfaceXRemovingCollection<E>
- Returns:
- the number of discarded entries.
-
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<E>
- Parameters:
element
- to be searched in the collection- Returns:
- Whether this collection contains the given element as specified by the
Equalator
.
-
containsAll
- Specified by:
containsAll
in interfaceXGettingCollection<E>
- Parameters:
elements
- to be searched in the collection.- Returns:
- Whether this collection contains all given elements as specified by the
Equalator
.
-
containsId
Description copied from interface:XGettingCollection
Special version of contains() that guarantees to use identity comparison (" == ") when searching for the given element regardless of the collection's internal logic.
This method has the same behavior asXGettingCollection.containsSearched(Predicate)
with aPredicate
implementation that checks for object identity. The only difference is a performance and usability advantage- Specified by:
containsId
in interfaceXGettingCollection<E>
- Parameters:
element
- the element to be searched in the collection by identity.- Returns:
- whether this collection contains exactly the given element.
-
filterTo
Description copied from interface:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection which testtrue
on the given predicate.Since all MicroStream Collections implement the
Consumer
interface, new collections can be used as target.Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3);
BulkList<Integer> filteredCollection = collection1.filterTo(BulkList.New(), e-> e % 2 == 0);
Results infilteredCollection
containing 2.- Specified by:
filterTo
in interfaceXGettingCollection<E>
- Parameters:
target
- on which theConsumer.accept(Object)
is called for elements that testtrue
.predicate
- on which to test all elements.- Returns:
- Given target
-
copyTo
Description copied from interface:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection.Since all MicroStream Collections implement the
Consumer
interface, new collections can be used as target.Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3);
BulkList<Integer> copiedCollection = collection1.copyTo(BulkList.New());
Results incopiedCollection
containing 1, 2 and 3.- Specified by:
copyTo
in interfaceXGettingCollection<E>
- Parameters:
target
- on which theConsumer.accept(Object)
is called for all elements of this collection.- Returns:
- Given target
-
count
Description copied from interface:XGettingCollection
Count how many times this element matches another element in the collection using theEqualator
.- Specified by:
count
in interfaceXGettingCollection<E>
- Parameters:
element
- 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<E>
- Parameters:
predicate
- defines which elements are counted and which are not- Returns:
- Amount of matches
-
distinct
Description copied from interface:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
for all the unique/distinct elements of this collection. This means the elements are not equal to each other.
Uniqueness is defined by the givenEqualator
.Since all MicroStream Collections implement the
Consumer
interface, new collections can be used as target.Example:
BulkList<Integer> collection1 = BulkList.New(1,2,2,3);
BulkList<Integer> distinctCollection = collection1.distinct(BulkList.New(), Equalator.identity());
Results indistinctCollection
containing 1, 2 and 3.- Specified by:
distinct
in interfaceXGettingCollection<E>
- 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
-
distinct
Description copied from interface:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
for all the unique/distinct elements of this collection. This means the elements are not equal to each other.
Uniqueness is defined by the collections internalEqualator
.Since all MicroStream Collections implement the
Consumer
interface, new collections can be used as target.Example:
BulkList<Integer> collection1 = BulkList.New(1,2,2,3);
BulkList<Integer> distinctCollection = collection1.distinct(BulkList.New());
Results indistinctCollection
containing 1, 2 and 3.- Specified by:
distinct
in interfaceXGettingCollection<E>
- Parameters:
target
- on which theConsumer.accept(Object)
is called for every distinct element of this collection.- Returns:
- Given target
-
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
-
ensureCapacity
- Specified by:
ensureCapacity
in interfaceCapacityExtendable
-
equals
Deprecated.Description copied from interface:XGettingCollection
Performs an equality comparison according to the specification inCollection
.Note that it is this interface's author opinion that the whole concept of equals() in standard Java, especially in the collection implementations, is flawed.
The reason is because all different kinds of comparison types that actually depend on the situation have to be mixed up in a harcoded fashion in one method, from identity comparison over data indentity comparison to content comparison.
In order to get the right behavior in every situation, one has to distinct between different types of equality
This means several things:
1.) You can't just say for example an ArrayList is the "same" as a LinkedList just because they contain the same content.
There are different implementations for a good reason, so you have to distinct them when comparing. There are simple code examples which create massive misbehavior that will catastrophically ruin the runtime behavior of a programm due to this error in Java / JDK / Sun / whatever.
2.) You can't always determine equality of two collections by determining equality of each element asCollection
defines it.As a conclusion: don't use this method!
Be clear what type of comparison you really need, then use one of the following methods and proper comparators:
XGettingCollection.equals(XGettingCollection, Equalator)
XGettingCollection.equalsContent(XGettingCollection, Equalator)
- Specified by:
equals
in interfaceXGettingCollection<E>
- Overrides:
equals
in classObject
-
equals
public final boolean equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)- Specified by:
equals
in interfaceXGettingCollection<E>
- Parameters:
samples
- is the collection which is checked for equalityequalator
- is used to check the equality of the collections- Returns:
true
if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)
yieldstrue
-
equalsContent
public final boolean equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)Description copied from interface:XGettingCollection
Returnstrue
if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.Note that for colletion types that don't have a defined order of elements, this method is hardly usable (as is
XGettingCollection.equals(Object)
for them as defined inCollection
). The core problem of comparing collections that have no defined order is that they aren't really reliably comparable to any other collection.- Specified by:
equalsContent
in interfaceXGettingCollection<E>
- Parameters:
samples
- is the collection which is checked for equalityequalator
- the equalator to use to determine the equality of each element- Returns:
true
if this list is equal to the passed list,false
otherwise
-
except
public final <C extends Consumer<? super E>> C except(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)Description copied from interface:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
for each element of this collection that is not contained in the other collection (through the given equalator).Since all MicroStream Collections implement the
Consumer
interface, new collections can be used as target.Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3);
BulkList<Integer> collection2 = BulkList.New(2,3,4);
BulkList<Integer> exceptCollection = collection1.except(collection2, Equalator.identity(), BulkList.New());
Results inexceptCollection
containing 1.- Specified by:
except
in interfaceXGettingCollection<E>
- Type Parameters:
C
- type of the target- Parameters:
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
-
iterate
Description copied from interface:XIterable
Executes the given procedure for each element of theXIterable
until all elements have been processed or the action throws an exception. Unless otherwise specified by the implementing class, procedures are performed in the order of iteration (if an iteration order is specified). Exceptions thrown by the procedure are relayed to the caller.
Should be identical toIterable.forEach(Consumer)
. -
join
Description copied from interface:XJoinable
Iterates over all elements of the collections and calls the joiner with each element and the aggregate. -
hashCode
Deprecated.- Specified by:
hashCode
in interfaceXGettingCollection<E>
- Overrides:
hashCode
in classObject
-
hasVolatileElements
public final boolean hasVolatileElements()Description copied from interface:ExtendedCollection
Tells if this collection contains volatile elements.
An element is volatile, if it can become no longer reachable by the collection without being removed from the collection. Examples areWeakReference
ofSoftReference
or implementations of collection entries that remove the element contained in an entry by some means outside the collection.
Note thatWeakReference
instances that are added to a a simple (non-volatile) implementation of a collection do not make the collection volatile, as the elements themselves (the reference instances) are still strongly referenced.- Specified by:
hasVolatileElements
in interfaceExtendedCollection<E>
- Specified by:
hasVolatileElements
in interfaceXGettingCollection<E>
- Returns:
true
if the collection contains volatile elements.
-
intersect
public final <C extends Consumer<? super E>> C intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)Description copied from interface:XGettingCollection
Tests equality between each element of the two lists and callsConsumer.accept(Object)
on the targetConsumer
for the equal elements.
Therefore it effectively creates a mathematical intersection between the two collections.Since all MicroStream Collections implement the
Consumer
interface, new collections can be used as target.Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3);
BulkList<Integer> collection2 = BulkList.New(2,3,4);
BulkList<Integer> intersection = collection1.intersect(collection2, Equalator.identity(), BulkList.New());
Results inintersection
containing 2 and 3.- Specified by:
intersect
in interfaceXGettingCollection<E>
- Parameters:
other
- collection to intersect with.equalator
- which is used for the equal-tests.target
- on which theConsumer.accept(Object)
is called for equal elements.- Returns:
- Given target
-
isEmpty
public final boolean isEmpty() -
iterator
-
max
- Specified by:
max
in interfaceXGettingCollection<E>
-
min
- Specified by:
min
in interfaceXGettingCollection<E>
-
moveTo
- Specified by:
moveTo
in interfaceXProcessingCollection<E>
-
process
- Specified by:
process
in interfaceProcessable<E>
-
fetch
- Specified by:
fetch
in interfaceXProcessingCollection<E>
-
pinch
- Specified by:
pinch
in interfaceXProcessingCollection<E>
-
removeBy
- Specified by:
removeBy
in interfaceXProcessingCollection<E>
-
retrieve
- Specified by:
retrieve
in interfaceXProcessingCollection<E>
-
retrieveBy
- Specified by:
retrieveBy
in interfaceXProcessingCollection<E>
-
removeOne
- Specified by:
removeOne
in interfaceXRemovingCollection<E>
-
remove
- Specified by:
remove
in interfaceXRemovingCollection<E>
-
removeAll
- Specified by:
removeAll
in interfaceXRemovingCollection<E>
-
removeDuplicates
- Specified by:
removeDuplicates
in interfaceXProcessingCollection<E>
-
removeDuplicates
public final long removeDuplicates()- Specified by:
removeDuplicates
in interfaceXRemovingCollection<E>
-
retainAll
Description copied from interface:XRemovingCollection
Removing all elements except the ones contained in the given elements-collection.Basically intersect this collection with the given collection and only keeping the resulting elements.
- Specified by:
retainAll
in interfaceXRemovingCollection<E>
- Parameters:
samples
- to retain- Returns:
- Amount of deleted elements
-
seek
Description copied from interface:XGettingCollection
Returns the first contained element matching the passed sample as defined by the collection's equality logic or null, if no fitting element is contained. (For collections using referential equality, this method is basically just a variation ofXGettingCollection.contains(Object)
with a different return type. For collections with data-dependant equality, the returned element might be the same as the passed one or a data-wise equal one, depending on the content of the collection)- Specified by:
seek
in interfaceXGettingCollection<E>
- Parameters:
sample
- to seek in the collection- Returns:
- the first contained element matching the passed sample
-
search
Description copied from interface:XGettingCollection
Returns the first contained element matching the passed predicate.- Specified by:
search
in interfaceXGettingCollection<E>
- Parameters:
predicate
- defines which element is searched- Returns:
- Matching element
-
optimize
public final long optimize()Description copied from interface:OptimizableCollection
Optimizes the internal storage of this collection and returns the storage size of the collection after the process is complete.- Specified by:
optimize
in interfaceOptimizableCollection
- Specified by:
optimize
in interfaceXRemovingCollection<E>
- Returns:
- the storage size of the collection after the optimzation.
-
size
public final long size()- Specified by:
size
in interfaceSized
- Specified by:
size
in interfaceXGettingCollection<E>
-
toArray
Description copied from interface:XGettingCollection
Returns an array containing all of the elements in this collection.The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.
This method acts as bridge between MicroStream-based collections and Java-native-based APIs.
- Specified by:
toArray
in interfaceXGettingCollection<E>
- Returns:
- an array containing all of the elements in this collection
-
toArray
Description copied from interface:XGettingCollection
Returns a typed array containing all of the elements in this collection.The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.
This method acts as bridge between MicroStream-based collections and Java-native-based APIs.
- Specified by:
toArray
in interfaceXGettingCollection<E>
- Returns:
- a typed array containing all of the elements in this collection
-
truncate
public final void truncate()Description copied from interface:XRemovingCollection
Clears (and reinitializes if needed) this collection in the fastest possible way, i.e. by allocating a new and empty internal storage of default capacity. The collection will be empty after calling this method.- Specified by:
truncate
in interfaceTruncateable
- Specified by:
truncate
in interfaceXRemovingCollection<E>
-
union
public final <C extends Consumer<? super E>> C union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)Description copied from interface:XGettingCollection
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection. And calls it for all elements of the other collection, that are not already in this collection (defined by the givenEqualator
)
Therefore it effectively creates a mathematical union between the two collections.Since all MicroStream Collections implement the
Consumer
interface, new collections can be used as target.Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3);
BulkList<Integer> collection2 = BulkList.New(2,3,4);
BulkList<Integer> union = collection1.union(collection2, Equalator.identity(), BulkList.New());
Results inunion
containing 1, 2, 3 and 4.- Specified by:
union
in interfaceXGettingCollection<E>
- 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
-
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
-
remainingCapacity
public final long remainingCapacity()Description copied from interface:CapacityCarrying
Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.- Specified by:
remainingCapacity
in interfaceCapacityCarrying
-
nullAllowed
public final boolean nullAllowed()Description copied from interface:ExtendedCollection
Defines if null-elements are allowed inside the collection or not.- Specified by:
nullAllowed
in interfaceExtendedCollection<E>
- Returns:
true
if null is allowed inside the collection;false
if not
-
nullContained
public final boolean nullContained()- Specified by:
nullContained
in interfaceXGettingCollection<E>
-
nullRemove
public final long nullRemove()- Specified by:
nullRemove
in interfaceXRemovingCollection<E>
-
copy
Description copied from interface:XGettingCollection
Creates a true copy of this collection which references the same elements as this collection does at the time the method is called. The elements themselves are NOT copied (no deep copying).
The type of the returned set is the same as of this list if possible.- Specified by:
copy
in interfaceCopyable
- Specified by:
copy
in interfaceXAddGetCollection<E>
- Specified by:
copy
in interfaceXCollection<E>
- Specified by:
copy
in interfaceXGettingCollection<E>
- Specified by:
copy
in interfaceXPutGetCollection<E>
- Returns:
- a copy of this list
-
immure
Description copied from interface:XGettingCollection
Provides an instance of an immutable collection type with equal behavior and data as this instance.If this instance already is of an immutable collection type, it returns itself.
- Specified by:
immure
in interfaceXGettingCollection<E>
- 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<E>
- Returns:
- new read-only collection to view this collection
-
old
- Specified by:
old
in interfaceXGettingCollection<E>
-