Class ConstLinearEnum<E>
- All Implemented Interfaces:
Iterable<E>
,CapacityCarrying
,ExtendedCollection<E>
,ExtendedSequence<E>
,Sized
,XGettingCollection<E>
,XGettingEnum<E>
,XGettingSequence<E>
,XGettingSet<E>
,XImmutableCollection<E>
,XImmutableEnum<E>
,XImmutableSequence<E>
,XImmutableSet<E>
,XIndexIterable<E>
,XIterable<E>
,XJoinable<E>
,ThreadSafe
,IdentityEqualityLogic
,HashImmutable
,Copyable
,Immutable
public final class ConstLinearEnum<E> extends AbstractSimpleArrayCollection<E> implements XImmutableEnum<E>, IdentityEqualityLogic
- Version:
- 0.91, 2011-02-28
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ConstLinearEnum.OldConstEnum<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.XGettingCollection
XGettingCollection.Creator<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingEnum
XGettingEnum.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.XImmutableEnum
XImmutableEnum.Factory<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XIterable
XIterable.Executor<E>
-
Constructor Summary
Constructors Constructor Description ConstLinearEnum()
ConstLinearEnum(int initialCapacity)
ConstLinearEnum(E... elements)
ConstLinearEnum(E[] src, int srcStart, int srcLength)
ConstLinearEnum(ConstLinearEnum<? extends E> original)
ConstLinearEnum(XGettingCollection<? extends E> elements)
-
Method Summary
Modifier and Type Method Description boolean
applies(Predicate<? super E> predicate)
Tests each element of the collection on the given predicate.E
at(long index)
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)
ConstLinearEnum<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>>
CcopySelection(C target, long... indices)
Iterates through all the elements of the given indices and calls theConsumer.accept(Object)
on the targetConsumer
.<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.<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.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> samples, 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).<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
first()
Gets first element or throwsIndexOutOfBoundsException
if the collection is empty.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.ConstLinearEnum<E>
immure()
Always returns the already immutable collection instance itselflong
indexBy(Predicate<? super E> predicate)
Iterates forwards through the collection and returns the index of the first element that the passed {link Predicate} applies to immediately.
Stops iterating on the first element that the predicate applies to.long
indexOf(E element)
protected int
internalCountingAddAll(E[] elements)
protected int
internalCountingAddAll(E[] elements, int offset, int length)
protected int
internalCountingAddAll(XGettingCollection<? extends E> elements)
protected int
internalCountingPutAll(E[] elements)
protected int
internalCountingPutAll(E[] elements, int offset, int length)
protected int
internalCountingPutAll(XGettingCollection<? extends E> elements)
protected int[]
internalGetSectionIndices()
Defines the array sections in which the collection's elements are organized by one or more pairs of indices in the order corresponding to the collection's logical order of its contained elements.protected E[]
internalGetStorageArray()
This is an internal shortcut method to provide fast access to the various array-backed list implementations' storage arrays.
The purpose of this method is to allow access to the array only for read-only procedures, never for modifying accesses.protected int
internalSize()
<C extends Consumer<? super E>>
Cintersect(XGettingCollection<? extends E> samples, 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.boolean
isSorted(Comparator<? super E> comparator)
Tests if the collection is sorted according to the given comparator.<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.<P extends IndexedAcceptor<? super E>>
PiterateIndexed(P procedure)
Iterates over elements with theIndexedAcceptor
to use not only the element itself but also its coherent index.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
last()
Gets last element or throwsIndexOutOfBoundsException
if the collection is empty.long
lastIndexBy(Predicate<? super E> predicate)
Iterates backwards through the collection and returns the index of the last element that the passedPredicate
applies to immediately.
Stops iterating on the first element that the predicate applies to.long
lastIndexOf(E element)
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.long
maxIndex(Comparator<? super E> comparator)
E
min(Comparator<? super E> comparator)
long
minIndex(Comparator<? super E> comparator)
boolean
nullAllowed()
Defines if null-elements are allowed inside the collection or not.boolean
nullContained()
ConstLinearEnum.OldConstEnum<E>
old()
E
peek()
Gets last element or null if the collection is empty.E
poll()
Gets first element or null if the collection is empty.ConstLinearEnum<E>
range(long fromIndex, long toIndex)
long
remainingCapacity()
Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.<T> T[]
rngCopyTo(int startIndex, int length, T[] target, int offset)
long
scan(Predicate<? super E> predicate)
Iterates through the collection and returns the index of the last element that the passedPredicate
applied to ("scanning").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.ConstLinearEnum<E>
toReversed()
Creates a newXGettingSequence
with the reversed order of elements.String
toString()
<C extends Consumer<? super E>>
Cunion(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection.ConstLinearEnum<E>
view()
Creates a view of this collection and returns it.ConstLinearEnum<E>
view(long lowIndex, long highIndex)
Creates a sub-view of this collection and returns it.Methods inherited from class one.microstream.collections.AbstractSimpleArrayCollection
internalGetStorageArray
Methods inherited from class one.microstream.collections.AbstractArrayCollection
marker, newArray, newArray, pow2BoundMaxed
Methods inherited from class one.microstream.collections.AbstractExtendedCollection
ensureFreeArrayCapacity, validateIndex
-
Constructor Details
-
ConstLinearEnum
public ConstLinearEnum() -
ConstLinearEnum
public ConstLinearEnum(int initialCapacity) -
ConstLinearEnum
- Throws:
NullPointerException
-
ConstLinearEnum
- Throws:
NullPointerException
-
ConstLinearEnum
- Throws:
NullPointerException
-
ConstLinearEnum
-
-
Method Details
-
internalGetStorageArray
Description copied from class:AbstractSimpleArrayCollection
This is an internal shortcut method to provide fast access to the various array-backed list implementations' storage arrays.
The purpose of this method is to allow access to the array only for read-only procedures, never for modifying accesses.The returned array is expected to contain the elements of the list in simple order from index 0 on to index (size - 1), so for example an array-backed ring list (queue) can NOT (reasonably) extend this class.
- Specified by:
internalGetStorageArray
in classAbstractSimpleArrayCollection<E>
- Returns:
- the storage array used by the list, containing all elements in straight order.
-
internalSize
protected int internalSize()- Specified by:
internalSize
in classAbstractSimpleArrayCollection<E>
-
internalGetSectionIndices
protected int[] internalGetSectionIndices()Description copied from class:AbstractSectionedArrayCollection
Defines the array sections in which the collection's elements are organized by one or more pairs of indices in the order corresponding to the collection's logical order of its contained elements.Examples:
The trivial example would be {0,size} in case of standard sized array collections.
An example for actual sectioning would be {i,array.length - 1, 0,i - 1} in case of a ring buffer list comprised of two sections: one ranging from index i to array.length - 1 (with the oldest element located at i) and one ranging from 0 to i - 1 (with the newest element located at i - 1).- Specified by:
internalGetSectionIndices
in classAbstractSectionedArrayCollection<E>
- Returns:
- a list of index pairs defining all sections of the storage array in logical order.
-
equality
- Specified by:
equality
in interfaceXGettingCollection<E>
-
internalCountingAddAll
- Specified by:
internalCountingAddAll
in classAbstractExtendedCollection<E>
- Throws:
UnsupportedOperationException
-
internalCountingAddAll
protected int internalCountingAddAll(E[] elements, int offset, int length) throws UnsupportedOperationException- Specified by:
internalCountingAddAll
in classAbstractExtendedCollection<E>
- Throws:
UnsupportedOperationException
-
internalCountingAddAll
protected int internalCountingAddAll(XGettingCollection<? extends E> elements) throws UnsupportedOperationException- Specified by:
internalCountingAddAll
in classAbstractExtendedCollection<E>
- Throws:
UnsupportedOperationException
-
internalCountingPutAll
- Specified by:
internalCountingPutAll
in classAbstractExtendedCollection<E>
- Throws:
UnsupportedOperationException
-
internalCountingPutAll
protected int internalCountingPutAll(E[] elements, int offset, int length) throws UnsupportedOperationException- Specified by:
internalCountingPutAll
in classAbstractExtendedCollection<E>
- Throws:
UnsupportedOperationException
-
internalCountingPutAll
protected int internalCountingPutAll(XGettingCollection<? extends E> elements) throws UnsupportedOperationException- Specified by:
internalCountingPutAll
in classAbstractExtendedCollection<E>
- Throws:
UnsupportedOperationException
-
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 interfaceXGettingCollection<E>
- Specified by:
copy
in interfaceXGettingEnum<E>
- Specified by:
copy
in interfaceXGettingSequence<E>
- Specified by:
copy
in interfaceXGettingSet<E>
- Specified by:
copy
in interfaceXImmutableCollection<E>
- Specified by:
copy
in interfaceXImmutableEnum<E>
- Specified by:
copy
in interfaceXImmutableSequence<E>
- Specified by:
copy
in interfaceXImmutableSet<E>
- Returns:
- a copy of this list
-
immure
Description copied from interface:XImmutableEnum
Always returns the already immutable collection instance itselfFor spawning a copy of the collection instance, see
XImmutableCollection.copy()
- Specified by:
immure
in interfaceXGettingCollection<E>
- Specified by:
immure
in interfaceXGettingEnum<E>
- Specified by:
immure
in interfaceXGettingSequence<E>
- Specified by:
immure
in interfaceXGettingSet<E>
- Specified by:
immure
in interfaceXImmutableCollection<E>
- Specified by:
immure
in interfaceXImmutableEnum<E>
- Specified by:
immure
in interfaceXImmutableSequence<E>
- Specified by:
immure
in interfaceXImmutableSet<E>
- Returns:
- a reference to the instance itself.
- See Also:
XImmutableCollection.copy()
-
toReversed
Description copied from interface:XGettingSequence
Creates a newXGettingSequence
with the reversed order of elements.This method creates a new collection and does not change the existing collection.
- Specified by:
toReversed
in interfaceXGettingEnum<E>
- Specified by:
toReversed
in interfaceXGettingSequence<E>
- Specified by:
toReversed
in interfaceXImmutableEnum<E>
- Specified by:
toReversed
in interfaceXImmutableSequence<E>
- Returns:
- New copy of the 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
-
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)
.- Specified by:
iterate
in interfaceXGettingEnum<E>
- Specified by:
iterate
in interfaceXGettingSet<E>
- Specified by:
iterate
in interfaceXIterable<E>
- Type Parameters:
P
- type of procedure- Parameters:
procedure
- The procedure to be performed for each element- Returns:
- Given procedure
-
iterateIndexed
Description copied from interface:XIndexIterable
Iterates over elements with theIndexedAcceptor
to use not only the element itself but also its coherent index.- Specified by:
iterateIndexed
in interfaceXIndexIterable<E>
- Type Parameters:
P
- type of procedure- Parameters:
procedure
- which is executed when iterating- Returns:
- Given procedure
-
join
Description copied from interface:XJoinable
Iterates over all elements of the collections and calls the joiner with each element and the aggregate. -
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
-
indexOf
- Specified by:
indexOf
in interfaceXGettingSequence<E>
-
indexBy
Description copied from interface:XGettingSequence
Iterates forwards through the collection and returns the index of the first element that the passed {link Predicate} applies to immediately.
Stops iterating on the first element that the predicate applies to.Basically the opposite of
XGettingSequence.lastIndexBy(Predicate)
- Specified by:
indexBy
in interfaceXGettingSequence<E>
- Parameters:
predicate
- to define a valid element- Returns:
- The index of the first positively tested element.
-
lastIndexOf
- Specified by:
lastIndexOf
in interfaceXGettingSequence<E>
-
lastIndexBy
Description copied from interface:XGettingSequence
Iterates backwards through the collection and returns the index of the last element that the passedPredicate
applies to immediately.
Stops iterating on the first element that the predicate applies to.Basically the opposite of
XGettingSequence.indexBy(Predicate)
.
Similar but not the same asXGettingSequence.scan(Predicate)
, sincescan
iterates through all elements.- Specified by:
lastIndexBy
in interfaceXGettingSequence<E>
- Parameters:
predicate
- to define a valid element- Returns:
- the index of the last positively tested element.
-
maxIndex
- Specified by:
maxIndex
in interfaceXGettingSequence<E>
-
minIndex
- Specified by:
minIndex
in interfaceXGettingSequence<E>
-
scan
Description copied from interface:XGettingSequence
Iterates through the collection and returns the index of the last element that the passedPredicate
applied to ("scanning").In order to find the last element, this method must iterate over all elements of the collection (opposed to
XGettingSequence.indexBy(Predicate)
andXGettingSequence.lastIndexBy(Predicate)
).Iteration can be safely canceled with a
ThrowBreak
(X.BREAK
)- Specified by:
scan
in interfaceXGettingSequence<E>
- Parameters:
predicate
- to define a valid element- Returns:
- the index of the last positively tested element.
-
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>
- Specified by:
get
in interfaceXGettingSequence<E>
- Returns:
- the first / any element.
- See Also:
XGettingSequence.at(long)
,XGettingSequence.first()
,XGettingSequence.last()
-
first
Description copied from interface:XGettingSequence
Gets first element or throwsIndexOutOfBoundsException
if the collection is empty.Is an alias for
XGettingSequence.get()
.- Specified by:
first
in interfaceXGettingSequence<E>
- Returns:
- First element
-
last
Description copied from interface:XGettingSequence
Gets last element or throwsIndexOutOfBoundsException
if the collection is empty.- Specified by:
last
in interfaceXGettingSequence<E>
- Returns:
- Last element
-
poll
Description copied from interface:XGettingSequence
Gets first element or null if the collection is empty.- Specified by:
poll
in interfaceXGettingSequence<E>
- Returns:
- First element or null
-
peek
Description copied from interface:XGettingSequence
Gets last element or null if the collection is empty.
This behaves like peeking on a stack without pop.- Specified by:
peek
in interfaceXGettingSequence<E>
- Returns:
- Last element or null
-
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
-
max
- Specified by:
max
in interfaceXGettingCollection<E>
-
min
- Specified by:
min
in interfaceXGettingCollection<E>
-
hasVolatileElements
public 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.
-
nullAllowed
public 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
-
isSorted
Description copied from interface:XGettingSequence
Tests if the collection is sorted according to the given comparator.- Specified by:
isSorted
in interfaceXGettingSequence<E>
- Parameters:
comparator
- defines if elements are sorted- Returns:
- true if it sorted, false if not
-
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.
-
nullContained
public boolean nullContained()- Specified by:
nullContained
in interfaceXGettingCollection<E>
-
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.
-
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
.
-
equals
- 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 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
-
intersect
public <C extends Consumer<? super E>> C intersect(XGettingCollection<? extends E> samples, 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:
samples
- 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
-
except
public <C extends Consumer<? super E>> C except(XGettingCollection<? extends E> samples, 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:
samples
- 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
-
union
public <C extends Consumer<? super E>> C union(XGettingCollection<? extends E> samples, 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:
samples
- 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
-
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
-
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
-
rngCopyTo
public <T> T[] rngCopyTo(int startIndex, int length, T[] target, int offset) -
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
-
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
-
copySelection
Description copied from interface:XGettingSequence
Iterates through all the elements of the given indices and calls theConsumer.accept(Object)
on the targetConsumer
.- Specified by:
copySelection
in interfaceXGettingSequence<E>
- Type Parameters:
C
- type of the target- Parameters:
target
- on which theConsumer.accept(Object)
is calledindices
- of the elements which are copied- Returns:
- Given target
-
isEmpty
public boolean isEmpty() -
iterator
-
size
public long size()- Specified by:
size
in interfaceSized
- Specified by:
size
in interfaceXGettingCollection<E>
-
maximumCapacity
public 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 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 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
-
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>
- Specified by:
view
in interfaceXGettingEnum<E>
- Specified by:
view
in interfaceXGettingSequence<E>
- Returns:
- new read-only collection to view this collection
-
view
Description copied from interface:XGettingSequence
Creates a sub-view of this collection and returns it. It is a read-only collection, which wraps around this collection and only allows read methods.
The view is limited to a range from the lowIndex to the highIndex.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 interfaceXGettingEnum<E>
- Specified by:
view
in interfaceXGettingSequence<E>
- Parameters:
lowIndex
- defines lower boundary for the view of the collection.highIndex
- defines higher boundary for the view of the collection.- Returns:
- new read-only collection to view a range of elements in this collection
-
range
- Specified by:
range
in interfaceXGettingEnum<E>
- Specified by:
range
in interfaceXGettingSequence<E>
-
toString
-
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
-
at
- Specified by:
at
in interfaceXGettingSequence<E>
- Throws:
ArrayIndexOutOfBoundsException
-
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 interfaceHashImmutable
- Specified by:
equals
in interfaceXGettingCollection<E>
- Overrides:
equals
in classObject
- Parameters:
o
- the reference object with which to compare.- Returns:
true
if this object can be treated as the same as other,false
otherwise.- See Also:
HashImmutable.hashCode()
-
hashCode
Deprecated.Description copied from interface:HashImmutable
Marker declaration to indicate that for classes of this type,Object.hashCode()
can be properly used.- Specified by:
hashCode
in interfaceHashImmutable
- Specified by:
hashCode
in interfaceXGettingCollection<E>
- Overrides:
hashCode
in classObject
- Returns:
- a hash code value for this object corresponding to the implementation of
HashImmutable.equals(Object)
- See Also:
HashImmutable.equals(java.lang.Object)
-
old
- Specified by:
old
in interfaceXGettingCollection<E>
-