Class SynchCollection<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 SynchCollection<E> extends Object implements XCollection<E>, Synchronized
XCollection instance in public synchronized delegate methods.-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSynchCollection.OldSynchCollection<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 SynchCollection(XCollection<E> collection)Creates a newSynchCollectionthat wraps the passedXCollectioninstance. -
Method Summary
Modifier and Type Method Description voidaccept(E e)booleanadd(E e)SynchCollection<E>addAll(E... elements)SynchCollection<E>addAll(E[] elements, int offset, int length)SynchCollection<E>addAll(XGettingCollection<? extends E> elements)booleanapplies(Predicate<? super E> 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)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)SynchCollection<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)longcount(E element)longcountBy(Predicate<? super E> predicate)longcurrentCapacity()Returns the current amount of elements this instance can hold before a storage rebuild becomes necessary.<C extends Consumer<? super E>>
Cdistinct(C target)<C extends Consumer<? super E>>
Cdistinct(C target, Equalator<? super E> equalator)SynchCollection<E>ensureCapacity(long minimalCapacity)SynchCollection<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)Returnstrueif the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)yieldstrue.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)Efetch()<C extends Consumer<? super E>>
CfilterTo(C target, Predicate<? super E> 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.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)booleanisEmpty()booleanisFull()Returns true if the current capacity cannot be increased any more.<P extends Consumer<? super E>>
Piterate(P procedure)Iterator<E>iterator()<A> Ajoin(BiConsumer<? super E,? super A> joiner, A 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()booleannullContained()booleannullPut()longnullRemove()SynchCollection.OldSynchCollection<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)SynchCollection<E>putAll(E... elements)SynchCollection<E>putAll(E[] elements, int offset, int length)SynchCollection<E>putAll(XGettingCollection<? extends E> elements)longremainingCapacity()Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.longremove(E element)longremoveAll(XGettingCollection<? extends E> samples)longremoveBy(Predicate<? super E> predicate)longremoveDuplicates()longremoveDuplicates(Equalator<? super E> equalator)booleanremoveOne(E element)longretainAll(XGettingCollection<? extends E> samples)Eretrieve(E element)EretrieveBy(Predicate<? super E> predicate)Esearch(Predicate<? super E> 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()E[]toArray(Class<E> type)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)View<E>view()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
-
SynchCollection
Creates a newSynchCollectionthat wraps the passedXCollectioninstance.- Parameters:
collection- theXCollectioninstance to be wrapped (synchronized).
-
-
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 interfaceXAddingCollection<E>- Specified by:
addAllin interfaceXCollection<E>- Specified by:
addAllin interfaceXPutGetCollection<E>
-
nullAdd
public final boolean nullAdd()- Specified by:
nullAddin interfaceXAddingCollection<E>
-
add
- Specified by:
addin interfaceXAddingCollection<E>
-
addAll
- Specified by:
addAllin interfaceXAddGetCollection<E>- Specified by:
addAllin interfaceXAddingCollection<E>- Specified by:
addAllin interfaceXCollection<E>- Specified by:
addAllin interfaceXPutGetCollection<E>
-
addAll
- Specified by:
addAllin interfaceXAddGetCollection<E>- Specified by:
addAllin interfaceXAddingCollection<E>- Specified by:
addAllin interfaceXCollection<E>- Specified by:
addAllin interfaceXPutGetCollection<E>
-
nullPut
public final boolean nullPut()- Specified by:
nullPutin interfaceXPuttingCollection<E>
-
accept
-
put
- Specified by:
putin interfaceXPuttingCollection<E>
-
putAll
- Specified by:
putAllin interfaceXCollection<E>- Specified by:
putAllin interfaceXPutGetCollection<E>- Specified by:
putAllin interfaceXPuttingCollection<E>
-
putAll
- Specified by:
putAllin interfaceXCollection<E>- Specified by:
putAllin interfaceXPutGetCollection<E>- Specified by:
putAllin interfaceXPuttingCollection<E>
-
putAll
- Specified by:
putAllin interfaceXCollection<E>- Specified by:
putAllin interfaceXPutGetCollection<E>- Specified by:
putAllin interfaceXPuttingCollection<E>
-
containsSearched
- Specified by:
containsSearchedin interfaceXGettingCollection<E>
-
applies
- Specified by:
appliesin interfaceXGettingCollection<E>
-
clear
public final 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 final long consolidate()Description copied from interface:XRemovingCollectionConsolidates 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).If this is not possible or not needed in the concrete implementation, this method does nothing and returns 0.
- Specified by:
consolidatein interfaceConsolidatableCollection- Specified by:
consolidatein interfaceXRemovingCollection<E>- Returns:
- the number of discarded entries.
-
contains
- Specified by:
containsin interfaceXGettingCollection<E>
-
containsAll
- Specified by:
containsAllin interfaceXGettingCollection<E>
-
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 exactely the given element.
-
filterTo
- Specified by:
filterToin interfaceXGettingCollection<E>
-
copyTo
- Specified by:
copyToin interfaceXGettingCollection<E>
-
count
- Specified by:
countin interfaceXGettingCollection<E>
-
countBy
- Specified by:
countByin interfaceXGettingCollection<E>
-
distinct
- Specified by:
distinctin interfaceXGettingCollection<E>
-
distinct
- Specified by:
distinctin interfaceXGettingCollection<E>
-
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
public final boolean equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)Description copied from interface:XGettingCollectionReturnstrueif the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)yieldstrue.- Specified by:
equalsin interfaceXGettingCollection<E>
-
equalsContent
public final 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>equalator- the equalator to use to determine the equality of each element- Returns:
trueif 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)- Specified by:
exceptin interfaceXGettingCollection<E>
-
iterate
-
join
-
hashCode
Deprecated.- Specified by:
hashCodein interfaceXGettingCollection<E>- Overrides:
hashCodein classObject
-
hasVolatileElements
public final boolean hasVolatileElements()Description copied from interface:XGettingCollectionTells 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 final <C extends Consumer<? super E>> C intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)- Specified by:
intersectin interfaceXGettingCollection<E>
-
isEmpty
public final 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 final long removeDuplicates()- Specified by:
removeDuplicatesin interfaceXRemovingCollection<E>
-
retainAll
- Specified by:
retainAllin interfaceXRemovingCollection<E>
-
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>
-
search
- Specified by:
searchin interfaceXGettingCollection<E>
-
optimize
public final 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 final long size()- Specified by:
sizein interfaceSized- Specified by:
sizein interfaceXGettingCollection<E>
-
toArray
- Specified by:
toArrayin interfaceXGettingCollection<E>
-
toArray
- Specified by:
toArrayin interfaceXGettingCollection<E>
-
truncate
public final 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 final <C extends Consumer<? super E>> C union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)- Specified by:
unionin interfaceXGettingCollection<E>
-
currentCapacity
public final 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 final 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 final boolean isFull()Description copied from interface:CapacityCarryingReturns true if the current capacity cannot be increased any more.- Specified by:
isFullin interfaceCapacityCarrying
-
remainingCapacity
public final 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
-
nullAllowed
public final boolean nullAllowed()- Specified by:
nullAllowedin interfaceExtendedCollection<E>
-
nullContained
public final boolean nullContained()- Specified by:
nullContainedin interfaceXGettingCollection<E>
-
nullRemove
public final long nullRemove()- Specified by:
nullRemovein interfaceXRemovingCollection<E>
-
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 interfaceXCollection<E>- Specified by:
copyin interfaceXGettingCollection<E>- Specified by:
copyin interfaceXPutGetCollection<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>- Returns:
- an immutable copy of this collection instance.
-
view
- Specified by:
viewin interfaceXGettingCollection<E>
-
old
- Specified by:
oldin interfaceXGettingCollection<E>
-