Package one.microstream.collections
Class Collector<E>
java.lang.Object
one.microstream.collections.Collector<E>
- All Implemented Interfaces:
Consumer<E>,CapacityCarrying,CapacityExtendable,ExtendedCollection<E>,OptimizableCollection,Sized,XAddingCollection<E>,XPuttingCollection<E>
public final class Collector<E> extends Object implements XPuttingCollection<E>
-
Nested Class Summary
Nested classes/interfaces inherited from interface one.microstream.collections.types.XPuttingCollection
XPuttingCollection.Creator<E> -
Constructor Summary
Constructors Constructor Description Collector(XPuttingCollection<E> collection) -
Method Summary
Modifier and Type Method Description voidaccept(E e)booleanadd(E e)Adds the passed element.Collector<E>addAll(E... elements)Collector<E>addAll(E[] elements, int offset, int length)Collector<E>addAll(XGettingCollection<? extends E> elements)longcurrentCapacity()Returns the current amount of elements this instance can hold before a storage rebuild becomes necessary.Collector<E>ensureCapacity(long minimalCapacity)Collector<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.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.booleanisEmpty()booleanisFull()Returns true if the current capacity cannot be increased any more.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.booleannullAdd()booleannullAllowed()Defines if null-elements are allowed inside the collection or not.booleannullPut()longoptimize()Optimizes the internal storage of this collection and returns the storage size of the collection after the process is complete.booleanput(E element)Adds the specified element to this collection if it is not already present (optional operation).Collector<E>putAll(E... elements)Adds the specified elements to this collection if it is not already present (optional operation).Collector<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.Collector<E>putAll(XGettingCollection<? extends E> elements)Adds the specified elements to this collection if it is not already present (optional operation).longremainingCapacity()Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.longsize()Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface one.microstream.collections.interfaces.CapacityExtendable
currentFreeCapacity
-
Constructor Details
-
Method Details
-
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 interfaceXAddingCollection<E>
-
addAll
- Specified by:
addAllin interfaceXAddingCollection<E>
-
addAll
- Specified by:
addAllin interfaceXAddingCollection<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:
element- to add- Returns:
- true if this collection did not already contain the specified element
-
putAll
Description copied from interface:XPuttingCollectionAdds the specified elements to this collection if it is not already present (optional operation).- Specified by:
putAllin interfaceXPuttingCollection<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 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:XPuttingCollectionAdds the specified elements to this collection if it is not already present (optional operation).- Specified by:
putAllin interfaceXPuttingCollection<E>- Parameters:
elements- to add- Returns:
- this
-
ensureCapacity
- Specified by:
ensureCapacityin interfaceCapacityExtendable
-
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
-
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
-
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- Returns:
- the storage size of the collection after the optimzation.
-
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>- Returns:
trueif the collection contains volatile elements.
-
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
-
isEmpty
- Specified by:
isEmptyin interfaceSized- Throws:
UnsupportedOperationException
-
size
- Specified by:
sizein interfaceSized- Throws:
UnsupportedOperationException
-