Class SynchSet<E>
- All Implemented Interfaces:
Iterable<E>,Consumer<E>,CapacityCarrying,CapacityExtendable,ConsolidatableCollection,ExtendedCollection<E>,OptimizableCollection,ReleasingCollection<E>,Sized,Truncateable,XAddGetCollection<E>,XAddGetSet<E>,XAddingCollection<E>,XAddingSet<E>,XCollection<E>,XGettingCollection<E>,XGettingSet<E>,XIterable<E>,XJoinable<E>,XProcessingCollection<E>,XProcessingSet<E>,XPutGetCollection<E>,XPutGetSet<E>,XPuttingCollection<E>,XPuttingSet<E>,XRemovingCollection<E>,XRemovingSet<E>,XSet<E>,Synchronized,ThreadSafe,Processable<E>,Clearable,Copyable
public final class SynchSet<E> extends Object implements XSet<E>, Synchronized
XSet instance in public synchronized delegate methods.-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSynchSet.OldSynchSet<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.XAddGetCollection
XAddGetCollection.Creator<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XAddingSet
XAddingSet.Creator<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.XGettingSet
XGettingSet.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>Nested classes/interfaces inherited from interface one.microstream.collections.types.XPuttingSet
XPuttingSet.Creator<E>Nested classes/interfaces inherited from interface one.microstream.collections.types.XSet
XSet.Factory<E> -
Constructor Summary
-
Method Summary
Modifier and Type Method Description voidaccept(E e)booleanadd(E e)Adds the passed element.SynchSet<E>addAll(E... elements)SynchSet<E>addAll(E[] elements, int offset, int length)SynchSet<E>addAll(XGettingCollection<? extends E> elements)EaddGet(E e)booleanapplies(Predicate<? super E> predicate)Tests each element of the collection on the given predicate.voidclear()Clears all elements from the collection while leaving the capacity as it is.longconsolidate()Consolidates the internal storage of this collection by discarding all elements of the internal storage that have become obsolete or otherwise unneeded anymore.booleancontains(E element)Checks if the given element is contained in the collection.booleancontainsAll(XGettingCollection<? extends E> elements)booleancontainsId(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 aPredicateimplementation that checks for object identity.booleancontainsSearched(Predicate<? super E> predicate)SynchSet<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 targetConsumerfor all the elements of this collection.longcount(E element)Count how many times this element matches another element in the collection using theEqualator.longcountBy(Predicate<? super E> predicate)Count how many matches are found using the given predicate on each element of the collection.longcurrentCapacity()Returns the current amount of elements this instance can hold before a storage rebuild becomes necessary.Ededuplicate(E e)<C extends Consumer<? super E>>
Cdistinct(C target)CallsConsumer.accept(Object)on the targetConsumerfor 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 targetConsumerfor all the unique/distinct elements of this collection.SynchSet<E>ensureCapacity(long minimalCapacity)SynchSet<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()booleanequals(Object o)Deprecated.booleanequals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)booleanequalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)Returnstrueif 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 targetConsumerfor each element of this collection that is not contained in the other collection (through the given equalator).Efetch()<C extends Consumer<? super E>>
CfilterTo(C target, Predicate<? super E> predicate)CallsConsumer.accept(Object)on the targetConsumerfor all the elements of this collection which testtrueon the given predicate.Eget()Gets one element from the collection.inthashCode()Deprecated.booleanhasVolatileElements()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.<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 targetConsumerfor the equal elements.
Therefore it effectively creates a mathematical intersection between the two collections.booleanisEmpty()booleanisFull()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 theXIterableuntil all elements have been processed or the action throws an exception.Iterator<E>iterator()<A> Ajoin(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.Emax(Comparator<? super E> comparator)longmaximumCapacity()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.Emin(Comparator<? super E> comparator)<C extends Consumer<? super E>>
CmoveTo(C target, Predicate<? super E> predicate)booleannullAdd()booleannullAllowed()Defines if null-elements are allowed inside the collection or not.booleannullContained()booleannullPut()longnullRemove()SynchSet.OldSynchSet<E>old()longoptimize()Optimizes the internal storage of this collection and returns the storage size of the collection after the process is complete.Epinch()<P extends Consumer<? super E>>
Pprocess(P procedure)booleanput(E e)Adds the specified element to this collection if it is not already present (optional operation).SynchSet<E>putAll(E... elements)Adds the specified elements to this collection if it is not already present (optional operation).SynchSet<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.SynchSet<E>putAll(XGettingCollection<? extends E> elements)Adds the specified elements to this collection if it is not already present (optional operation).EputGet(E e)longremainingCapacity()Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.longremove(E element)longremoveAll(XGettingCollection<? extends E> elements)longremoveBy(Predicate<? super E> predicate)longremoveDuplicates()longremoveDuplicates(Equalator<? super E> equalator)booleanremoveOne(E element)Ereplace(E e)longretainAll(XGettingCollection<? extends E> elements)Removing all elements except the ones contained in the given elements-collection.Eretrieve(E element)EretrieveBy(Predicate<? super E> predicate)Esearch(Predicate<? super E> predicate)Returns the first contained element matching the passed predicate.Eseek(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.longsize()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.voidtruncate()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 targetConsumerfor all the elements of this collection.SetView<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, waitMethods inherited from interface one.microstream.collections.interfaces.CapacityExtendable
currentFreeCapacity
-
Constructor Details
-
Method Details
-
get
Description copied from interface:XGettingCollectionGets 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:
getin interfaceXGettingCollection<E>- Returns:
- the first / any element.
-
equality
- Specified by:
equalityin interfaceXGettingCollection<E>
-
addAll
- Specified by:
addAllin interfaceXAddGetCollection<E>- Specified by:
addAllin interfaceXAddGetSet<E>- Specified by:
addAllin interfaceXAddingCollection<E>- Specified by:
addAllin interfaceXAddingSet<E>- Specified by:
addAllin interfaceXCollection<E>- Specified by:
addAllin interfaceXPutGetCollection<E>- Specified by:
addAllin interfaceXPutGetSet<E>- Specified by:
addAllin interfaceXPuttingSet<E>- Specified by:
addAllin interfaceXSet<E>
-
nullAdd
public boolean nullAdd()- Specified by:
nullAddin interfaceXAddingCollection<E>
-
add
Description copied from interface:XAddingCollectionAdds the passed element.- Specified by:
addin interfaceXAddingCollection<E>- Parameters:
e- to add- Returns:
trueif element was added;falseif not
-
addAll
- Specified by:
addAllin interfaceXAddGetCollection<E>- Specified by:
addAllin interfaceXAddGetSet<E>- Specified by:
addAllin interfaceXAddingCollection<E>- Specified by:
addAllin interfaceXAddingSet<E>- Specified by:
addAllin interfaceXCollection<E>- Specified by:
addAllin interfaceXPutGetCollection<E>- Specified by:
addAllin interfaceXPutGetSet<E>- Specified by:
addAllin interfaceXPuttingSet<E>- Specified by:
addAllin interfaceXSet<E>
-
addAll
- Specified by:
addAllin interfaceXAddGetCollection<E>- Specified by:
addAllin interfaceXAddGetSet<E>- Specified by:
addAllin interfaceXAddingCollection<E>- Specified by:
addAllin interfaceXAddingSet<E>- Specified by:
addAllin interfaceXCollection<E>- Specified by:
addAllin interfaceXPutGetCollection<E>- Specified by:
addAllin interfaceXPutGetSet<E>- Specified by:
addAllin interfaceXPuttingSet<E>- Specified by:
addAllin interfaceXSet<E>
-
nullPut
public boolean nullPut()- Specified by:
nullPutin interfaceXPuttingCollection<E>
-
accept
-
put
Description copied from interface:XPuttingCollectionAdds the specified element to this collection if it is not already present (optional operation).- Specified by:
putin interfaceXPuttingCollection<E>- Parameters:
e- to add- Returns:
- true if this collection did not already contain the specified element
-
addGet
- Specified by:
addGetin interfaceXAddGetSet<E>
-
deduplicate
- Specified by:
deduplicatein interfaceXAddGetSet<E>
-
putGet
- Specified by:
putGetin interfaceXPutGetSet<E>
-
replace
- Specified by:
replacein interfaceXPutGetSet<E>
-
putAll
Description copied from interface:XPuttingCollectionAdds the specified elements to this collection if it is not already present (optional operation).- Specified by:
putAllin interfaceXCollection<E>- Specified by:
putAllin interfaceXPutGetCollection<E>- Specified by:
putAllin interfaceXPutGetSet<E>- Specified by:
putAllin interfaceXPuttingCollection<E>- Specified by:
putAllin interfaceXPuttingSet<E>- Specified by:
putAllin interfaceXSet<E>- Parameters:
elements- to add- Returns:
- this
-
putAll
Description copied from interface:XPuttingCollectionAdds the specified elements to this collection if it is not already present (optional operation).- Specified by:
putAllin interfaceXCollection<E>- Specified by:
putAllin interfaceXPutGetCollection<E>- Specified by:
putAllin interfaceXPutGetSet<E>- Specified by:
putAllin interfaceXPuttingCollection<E>- Specified by:
putAllin interfaceXPuttingSet<E>- Specified by:
putAllin interfaceXSet<E>- Parameters:
elements- to add- Returns:
- this
-
putAll
Description copied from interface:XPuttingCollectionAdds 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:
putAllin interfaceXCollection<E>- Specified by:
putAllin interfaceXPutGetCollection<E>- Specified by:
putAllin interfaceXPutGetSet<E>- Specified by:
putAllin interfaceXPuttingCollection<E>- Specified by:
putAllin interfaceXPuttingSet<E>- Specified by:
putAllin interfaceXSet<E>- Parameters:
elements- to addoffset- start index of elements-array to add to collectionlength- length of elements-array to add to collection- Returns:
- this
-
containsSearched
- Specified by:
containsSearchedin interfaceXGettingCollection<E>
-
applies
Description copied from interface:XGettingCollectionTests each element of the collection on the given predicate.- Specified by:
appliesin 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 void clear()Description copied from interface:XRemovingCollectionClears all elements from the collection while leaving the capacity as it is.- Specified by:
clearin interfaceClearable- Specified by:
clearin interfaceXRemovingCollection<E>
-
consolidate
public long consolidate()Description copied from interface:ConsolidatableCollectionConsolidates the internal storage of this collection by discarding all elements of the internal storage that have become obsolete or otherwise unneeded anymore. (e.g.WeakReferenceentries whose reference has been cleared).- Specified by:
consolidatein interfaceConsolidatableCollection- Specified by:
consolidatein interfaceXRemovingCollection<E>- Returns:
- the number of discarded entries.
-
contains
Description copied from interface:XGettingCollectionChecks if the given element is contained in the collection.
In contrast to theXGettingCollection.containsId(Object)method, this method uses the internalEqualatordefined by the collection itself.- Specified by:
containsin 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:
containsAllin 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:XGettingCollectionSpecial 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 aPredicateimplementation that checks for object identity. The only difference is a performance and usability advantage- Specified by:
containsIdin interfaceXGettingCollection<E>- Parameters:
element- the element to be searched in the collection by identity.- Returns:
- whether this collection contains exactly the given element.
-
nullAllowed
public boolean nullAllowed()Description copied from interface:ExtendedCollectionDefines if null-elements are allowed inside the collection or not.- Specified by:
nullAllowedin interfaceExtendedCollection<E>- Returns:
trueif null is allowed inside the collection;falseif not
-
nullContained
public boolean nullContained()- Specified by:
nullContainedin interfaceXGettingCollection<E>
-
filterTo
Description copied from interface:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor all the elements of this collection which testtrueon the given predicate.Since all MicroStream Collections implement the
Consumerinterface, 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 infilteredCollectioncontaining 2.- Specified by:
filterToin 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:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor all the elements of this collection.Since all MicroStream Collections implement the
Consumerinterface, new collections can be used as target.Example:
BulkList<Integer> collection1 = BulkList.New(1,2,3);
BulkList<Integer> copiedCollection = collection1.copyTo(BulkList.New());
Results incopiedCollectioncontaining 1, 2 and 3.- Specified by:
copyToin 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:XGettingCollectionCount how many times this element matches another element in the collection using theEqualator.- Specified by:
countin interfaceXGettingCollection<E>- Parameters:
element- to count- Returns:
- Amount of matches
-
countBy
Description copied from interface:XGettingCollectionCount how many matches are found using the given predicate on each element of the collection.- Specified by:
countByin interfaceXGettingCollection<E>- Parameters:
predicate- defines which elements are counted and which are not- Returns:
- Amount of matches
-
distinct
Description copied from interface:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor 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
Consumerinterface, 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 indistinctCollectioncontaining 1, 2 and 3.- Specified by:
distinctin 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:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor 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
Consumerinterface, 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 indistinctCollectioncontaining 1, 2 and 3.- Specified by:
distinctin 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:CapacityExtendableEnsures 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:
ensureFreeCapacityin interfaceCapacityExtendable
-
ensureCapacity
- Specified by:
ensureCapacityin interfaceCapacityExtendable
-
equals
Deprecated.Description copied from interface:XGettingCollectionPerforms 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 asCollectiondefines 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:
equalsin interfaceXGettingCollection<E>- Overrides:
equalsin classObject
-
equals
- Specified by:
equalsin interfaceXGettingCollection<E>- Parameters:
samples- is the collection which is checked for equalityequalator- is used to check the equality of the collections- Returns:
trueif the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)yieldstrue
-
equalsContent
public boolean equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)Description copied from interface:XGettingCollectionReturnstrueif 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:
equalsContentin interfaceXGettingCollection<E>- Parameters:
samples- is the collection which is checked for equalityequalator- the equalator to use to determine the equality of each element- Returns:
trueif this list is equal to the passed list,falseotherwise
-
except
public <C extends Consumer<? super E>> C except(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)Description copied from interface:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor each element of this collection that is not contained in the other collection (through the given equalator).Since all MicroStream Collections implement the
Consumerinterface, 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 inexceptCollectioncontaining 1.- Specified by:
exceptin 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:XIterableExecutes the given procedure for each element of theXIterableuntil all elements have been processed or the action throws an exception. Unless otherwise specified by the implementing class, procedures are performed in the order of iteration (if an iteration order is specified). Exceptions thrown by the procedure are relayed to the caller.
Should be identical toIterable.forEach(Consumer).- Specified by:
iteratein interfaceXGettingSet<E>- Specified by:
iteratein interfaceXIterable<E>- Specified by:
iteratein interfaceXProcessingCollection<E>- Type Parameters:
P- type of procedure- Parameters:
procedure- The procedure to be performed for each element- Returns:
- Given procedure
-
join
Description copied from interface:XJoinableIterates over all elements of the collections and calls the joiner with each element and the aggregate. -
hashCode
Deprecated.- Specified by:
hashCodein interfaceXGettingCollection<E>- Overrides:
hashCodein classObject
-
hasVolatileElements
public boolean hasVolatileElements()Description copied from interface:ExtendedCollectionTells 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 areWeakReferenceofSoftReferenceor implementations of collection entries that remove the element contained in an entry by some means outside the collection.
Note thatWeakReferenceinstances 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:
hasVolatileElementsin interfaceExtendedCollection<E>- Specified by:
hasVolatileElementsin interfaceXGettingCollection<E>- Returns:
trueif the collection contains volatile elements.
-
intersect
public <C extends Consumer<? super E>> C intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)Description copied from interface:XGettingCollectionTests equality between each element of the two lists and callsConsumer.accept(Object)on the targetConsumerfor the equal elements.
Therefore it effectively creates a mathematical intersection between the two collections.Since all MicroStream Collections implement the
Consumerinterface, 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 inintersectioncontaining 2 and 3.- Specified by:
intersectin 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 boolean isEmpty() -
iterator
-
max
- Specified by:
maxin interfaceXGettingCollection<E>
-
min
- Specified by:
minin interfaceXGettingCollection<E>
-
moveTo
- Specified by:
moveToin interfaceXProcessingCollection<E>
-
process
- Specified by:
processin interfaceProcessable<E>
-
fetch
- Specified by:
fetchin interfaceXProcessingCollection<E>
-
pinch
- Specified by:
pinchin interfaceXProcessingCollection<E>
-
removeBy
- Specified by:
removeByin interfaceXProcessingCollection<E>
-
retrieve
- Specified by:
retrievein interfaceXProcessingCollection<E>
-
retrieveBy
- Specified by:
retrieveByin interfaceXProcessingCollection<E>
-
removeOne
- Specified by:
removeOnein interfaceXRemovingCollection<E>
-
remove
- Specified by:
removein interfaceXRemovingCollection<E>
-
removeAll
- Specified by:
removeAllin interfaceXRemovingCollection<E>
-
removeDuplicates
- Specified by:
removeDuplicatesin interfaceXProcessingCollection<E>
-
removeDuplicates
public long removeDuplicates()- Specified by:
removeDuplicatesin interfaceXRemovingCollection<E>
-
nullRemove
public long nullRemove()- Specified by:
nullRemovein interfaceXRemovingCollection<E>
-
retainAll
Description copied from interface:XRemovingCollectionRemoving 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:
retainAllin interfaceXRemovingCollection<E>- Parameters:
elements- to retain- Returns:
- Amount of deleted elements
-
seek
Description copied from interface:XGettingCollectionReturns 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:
seekin interfaceXGettingCollection<E>- Parameters:
sample- to seek in the collection- Returns:
- the first contained element matching the passed sample
-
search
Description copied from interface:XGettingCollectionReturns the first contained element matching the passed predicate.- Specified by:
searchin interfaceXGettingCollection<E>- Parameters:
predicate- defines which element is searched- Returns:
- Matching element
-
optimize
public long optimize()Description copied from interface:OptimizableCollectionOptimizes the internal storage of this collection and returns the storage size of the collection after the process is complete.- Specified by:
optimizein interfaceOptimizableCollection- Specified by:
optimizein interfaceXRemovingCollection<E>- Returns:
- the storage size of the collection after the optimzation.
-
size
public long size()- Specified by:
sizein interfaceSized- Specified by:
sizein interfaceXGettingCollection<E>
-
toArray
Description copied from interface:XGettingCollectionReturns 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:
toArrayin interfaceXGettingCollection<E>- Returns:
- an array containing all of the elements in this collection
-
toArray
Description copied from interface:XGettingCollectionReturns 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:
toArrayin interfaceXGettingCollection<E>- Returns:
- a typed array containing all of the elements in this collection
-
truncate
public void truncate()Description copied from interface:XRemovingCollectionClears (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:
truncatein interfaceTruncateable- Specified by:
truncatein interfaceXRemovingCollection<E>
-
union
public <C extends Consumer<? super E>> C union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)Description copied from interface:XGettingCollectionCallsConsumer.accept(Object)on the targetConsumerfor 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
Consumerinterface, 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 inunioncontaining 1, 2, 3 and 4.- Specified by:
unionin 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 long currentCapacity()Description copied from interface:CapacityExtendableReturns 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:
currentCapacityin interfaceCapacityExtendable- Returns:
- the current capacity of this instance before a rebuild is required.
-
maximumCapacity
public long maximumCapacity()Description copied from interface:CapacityCarryingReturns 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:
maximumCapacityin interfaceCapacityCarrying- Returns:
- the maximum amount of elements this carrier instance can contain.
-
isFull
public boolean isFull()Description copied from interface:CapacityCarryingReturns true if the current capacity cannot be increased any more.- Specified by:
isFullin interfaceCapacityCarrying
-
remainingCapacity
public long remainingCapacity()Description copied from interface:CapacityCarryingReturns the amount of elements this carrier instance can collect before reaching its maximimum capacity.- Specified by:
remainingCapacityin interfaceCapacityCarrying
-
copy
Description copied from interface:XGettingCollectionCreates 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:
copyin interfaceCopyable- Specified by:
copyin interfaceXAddGetCollection<E>- Specified by:
copyin interfaceXAddGetSet<E>- Specified by:
copyin interfaceXCollection<E>- Specified by:
copyin interfaceXGettingCollection<E>- Specified by:
copyin interfaceXGettingSet<E>- Specified by:
copyin interfaceXProcessingSet<E>- Specified by:
copyin interfaceXPutGetCollection<E>- Specified by:
copyin interfaceXPutGetSet<E>- Specified by:
copyin interfaceXSet<E>- Returns:
- a copy of this list
-
immure
Description copied from interface:XGettingCollectionProvides 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:
immurein interfaceXGettingCollection<E>- Specified by:
immurein interfaceXGettingSet<E>- Specified by:
immurein interfaceXProcessingSet<E>- Returns:
- an immutable copy of this collection instance.
-
view
Description copied from interface:XGettingCollectionCreates 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:
viewin interfaceXGettingCollection<E>- Returns:
- new read-only collection to view this collection
-
old
- Specified by:
oldin interfaceXGettingCollection<E>
-