Interface XReference<E>
- All Superinterfaces:
CapacityCarrying
,Consumer<E>
,Copyable
,ExtendedBag<E>
,ExtendedCollection<E>
,ExtendedList<E>
,ExtendedSequence<E>
,Iterable<E>
,Reference<E>
,Referencing<E>
,ReleasingCollection<E>
,Sized
,Sortable<E>
,XGettingBag<E>
,XGettingCollection<E>
,XGettingEnum<E>
,XGettingList<E>
,XGettingSequence<E>
,XGettingSet<E>
,XIndexIterable<E>
,XIterable<E>
,XJoinable<E>
,XOrderingEnum<E>
,XOrderingSequence<E>
,XReferencing<E>
,XReplacingBag<E>
,XReplacingCollection<E>
,XSettingList<E>
,XSettingSequence<E>
,XSortableEnum<E>
,XSortableSequence<E>
- All Known Implementing Classes:
LinkReference.Default
,Single
,Singleton
public interface XReference<E> extends XReferencing<E>, XSettingList<E>, XSortableEnum<E>, Reference<E>, Consumer<E>
Note: In most cases, a mutable reference object like this should not be neccessary if the program is well
structured (that's why no such class exists in the Java API).
Extensive use of this class where it would be better to restructure the program may end in even more structural
problems.
Yet in some cases, a mutable reference really is needed or at least helps in creating cleaner structures.
So again, use wisely.
-
Nested Class Summary
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.XGettingList
XGettingList.Factory<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingSequence
XGettingSequence.Factory<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.XReplacingBag
XReplacingBag.Factory<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XSettingList
XSettingList.Creator<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XSortableEnum
XSortableEnum.Creator<E>
-
Method Summary
Modifier and Type Method Description default void
accept(E element)
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)
XReference<E>
copy()
Creates a true copy of this list which references the same elements in the same order as this list does at the time the method is called.<T extends Consumer<? super E>>
TcopySelection(T target, long... indices)
Iterates through all the elements of the given indices and calls theConsumer.accept(Object)
on the targetConsumer
.<T extends Consumer<? super E>>
TcopyTo(T 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.<T extends Consumer<? super E>>
Tdistinct(T target)
CallsConsumer.accept(Object)
on the targetConsumer
for all the unique/distinct elements of this collection.<T extends Consumer<? super E>>
Tdistinct(T 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(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.<T extends Consumer<? super E>>
Texcept(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T 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).XReference<E>
fill(long offset, long length, E element)
Fills all slots from the offset to the offset+length with the given element, regardless of whether or not a slot isnull
.<T extends Consumer<? super E>>
TfilterTo(T 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.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.Constant<E>
immure()
Provides an instance of an immutable collection type with equal behavior and data as this instance.long
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)
<T extends Consumer<? super E>>
Tintersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T 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.Iterator<E>
iterator()
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)
ListIterator<E>
listIterator()
ListIterator<E>
listIterator(long index)
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()
OldList<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.XReference<E>
range(long fromIndex, long toIndex)
long
remainingCapacity()
Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.long
replace(E element, E replacement)
long
replace(Predicate<? super E> predicate, E substitute)
long
replaceAll(XGettingCollection<? extends E> elements, E replacement)
boolean
replaceOne(E element, E replacement)
Replaces the first element that is equal to the given element with the replacement and then returns true.boolean
replaceOne(Predicate<? super E> predicate, E substitute)
XReference<E>
reverse()
Reverses the order of its own elements and returns itself.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.boolean
set(long index, E element)
XReference<E>
set(long index, E[] elements, int offset, int length)
XReference<E>
set(long index, XGettingSequence<? extends E> elements, long offset, long length)
void
set(E element)
XReference<E>
setAll(long index, E... elements)
void
setFirst(E element)
E
setGet(long index, E element)
void
setLast(E element)
XReference<E>
shiftBy(long sourceIndex, long distance)
Moves the element from the sourceIndex in the sequence to a higher index position.
All other elements are possibly moved to create the empty slot for the shifting element.XReference<E>
shiftBy(long sourceIndex, long distance, long length)
Moves multiple elements from the sourceIndex in the sequence to a higher index position.
All other elements are possibly moved to create the empty slot for the shifting elements.XReference<E>
shiftTo(long sourceIndex, long targetIndex)
Moves the element from the sourceIndex in the sequence to the targetIndex.
All other elements are possibly moved to create the empty slot for the shifting element.XReference<E>
shiftTo(long sourceIndex, long targetIndex, long length)
Moves multiple elements from the sourceIndex in the sequence to the targetIndex.
All other elements are possibly moved to create the empty slot for the shifting element.long
size()
XReference<E>
sort(Comparator<? super E> comparator)
Sorts this collection according to the given comparator and returns itself.XReference<E>
swap(long indexA, long indexB)
XReference<E>
swap(long indexA, long indexB, long length)
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.XReference<E>
toReversed()
Creates a newXGettingSequence
with the reversed order of elements.<T extends Consumer<? super E>>
Tunion(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)
CallsConsumer.accept(Object)
on the targetConsumer
for all the elements of this collection.XReferencing<E>
view()
Creates a view of this collection and returns it.XReferencing<E>
view(long lowIndex, long highIndex)
Creates a sub-view of this collection and returns it.Methods inherited from interface one.microstream.collections.types.XGettingCollection
equals, hashCode, intSize, join
-
Method Details
-
set
-
accept
-
replaceOne
Description copied from interface:XReplacingBag
Replaces the first element that is equal to the given element with the replacement and then returns true.- Specified by:
replaceOne
in interfaceXReplacingBag<E>
- Parameters:
element
- to replacereplacement
- for the found element- Returns:
true
if element is found,false
if not
-
replace
- Specified by:
replace
in interfaceXReplacingBag<E>
-
replaceAll
- Specified by:
replaceAll
in interfaceXReplacingBag<E>
-
replaceOne
- Specified by:
replaceOne
in interfaceXReplacingBag<E>
-
replace
- Specified by:
replace
in interfaceXReplacingBag<E>
-
set
- Specified by:
set
in interfaceXSettingSequence<E>
-
setGet
- Specified by:
setGet
in interfaceXSettingSequence<E>
-
setFirst
- Specified by:
setFirst
in interfaceXSettingSequence<E>
-
setLast
- Specified by:
setLast
in interfaceXSettingSequence<E>
-
shiftTo
Description copied from interface:XOrderingSequence
Moves the element from the sourceIndex in the sequence to the targetIndex.
All other elements are possibly moved to create the empty slot for the shifting element.Does not expand or shrink the capacity of the sequence.
Throws a
IndexExceededException
if sourceIndex or targetIndex are greater than the size of the sequence.- Specified by:
shiftTo
in interfaceXOrderingEnum<E>
- Specified by:
shiftTo
in interfaceXOrderingSequence<E>
- Specified by:
shiftTo
in interfaceXSortableEnum<E>
- Specified by:
shiftTo
in interfaceXSortableSequence<E>
- Parameters:
sourceIndex
- points to the source element; Index of the source elementtargetIndex
- points to the target element; Index of the target element- Returns:
- this
-
shiftTo
Description copied from interface:XOrderingSequence
Moves multiple elements from the sourceIndex in the sequence to the targetIndex.
All other elements are possibly moved to create the empty slot for the shifting element.Does not expand or shrink the capacity of the sequence.
Throws a
IndexExceededException
if sourceIndex or targetIndex exceed the size of the sequence.- Specified by:
shiftTo
in interfaceXOrderingEnum<E>
- Specified by:
shiftTo
in interfaceXOrderingSequence<E>
- Specified by:
shiftTo
in interfaceXSortableEnum<E>
- Specified by:
shiftTo
in interfaceXSortableSequence<E>
- Parameters:
sourceIndex
- points to the source element; Index of the source elementtargetIndex
- points to the target element; Index of the target elementlength
- Amount of moved elements.- Returns:
- self
-
shiftBy
Description copied from interface:XOrderingSequence
Moves the element from the sourceIndex in the sequence to a higher index position.
All other elements are possibly moved to create the empty slot for the shifting element. ("to the right")Does not expand or shrink the capacity of the sequence.
Throws a
IndexExceededException
if sourceIndex or targetIndex (sourceIndex+distance) exceed the size of the sequence.- Specified by:
shiftBy
in interfaceXOrderingEnum<E>
- Specified by:
shiftBy
in interfaceXOrderingSequence<E>
- Specified by:
shiftBy
in interfaceXSortableEnum<E>
- Specified by:
shiftBy
in interfaceXSortableSequence<E>
- Parameters:
sourceIndex
- points to the source element; Index of the source elementdistance
- of how far the element should be moved. Example: 1 moves the element from position 21 to position 22- Returns:
- self
-
shiftBy
Description copied from interface:XOrderingSequence
Moves multiple elements from the sourceIndex in the sequence to a higher index position.
All other elements are possibly moved to create the empty slot for the shifting elements. ("to the right")Does not expand or shrink the capacity of the sequence.
Throws a
IndexExceededException
if sourceIndex or targetIndex (sourceIndex+distance+length) exceed the size of the sequence.- Specified by:
shiftBy
in interfaceXOrderingEnum<E>
- Specified by:
shiftBy
in interfaceXOrderingSequence<E>
- Specified by:
shiftBy
in interfaceXSortableEnum<E>
- Specified by:
shiftBy
in interfaceXSortableSequence<E>
- Parameters:
sourceIndex
- points to the source element; Index of the source elementdistance
- of how far the element should be moved. Example: 1 moves the element from position 21 to position 22length
- Amount of moved elements.- Returns:
- self
-
setAll
- Specified by:
setAll
in interfaceXSettingList<E>
- Specified by:
setAll
in interfaceXSettingSequence<E>
-
set
- Specified by:
set
in interfaceXSettingList<E>
- Specified by:
set
in interfaceXSettingSequence<E>
-
set
- Specified by:
set
in interfaceXSettingList<E>
- Specified by:
set
in interfaceXSettingSequence<E>
-
swap
- Specified by:
swap
in interfaceXOrderingEnum<E>
- Specified by:
swap
in interfaceXOrderingSequence<E>
- Specified by:
swap
in interfaceXSettingList<E>
- Specified by:
swap
in interfaceXSettingSequence<E>
- Specified by:
swap
in interfaceXSortableEnum<E>
- Specified by:
swap
in interfaceXSortableSequence<E>
-
swap
- Specified by:
swap
in interfaceXOrderingEnum<E>
- Specified by:
swap
in interfaceXOrderingSequence<E>
- Specified by:
swap
in interfaceXSettingList<E>
- Specified by:
swap
in interfaceXSettingSequence<E>
- Specified by:
swap
in interfaceXSortableEnum<E>
- Specified by:
swap
in interfaceXSortableSequence<E>
-
reverse
XReference<E> reverse()Description copied from interface:XSortableSequence
Reverses the order of its own elements and returns itself.Unlike the
XSortableSequence.toReversed()
method, this method does not create a new collection, but changes the order of its own elements.- Specified by:
reverse
in interfaceXOrderingEnum<E>
- Specified by:
reverse
in interfaceXOrderingSequence<E>
- Specified by:
reverse
in interfaceXSettingList<E>
- Specified by:
reverse
in interfaceXSettingSequence<E>
- Specified by:
reverse
in interfaceXSortableEnum<E>
- Specified by:
reverse
in interfaceXSortableSequence<E>
- Returns:
- this
-
fill
Description copied from interface:XSettingList
Fills all slots from the offset to the offset+length with the given element, regardless of whether or not a slot isnull
.- Specified by:
fill
in interfaceXSettingList<E>
- Parameters:
offset
- from the start of the collection (start index)length
- of how many slots should be filledelement
- to use for filling of slots- Returns:
- this
-
sort
Description copied from interface:Sortable
Sorts this collection according to the given comparator and returns itself.- Specified by:
sort
in interfaceSortable<E>
- Specified by:
sort
in interfaceXSettingList<E>
- Specified by:
sort
in interfaceXSettingSequence<E>
- Specified by:
sort
in interfaceXSortableEnum<E>
- Specified by:
sort
in interfaceXSortableSequence<E>
- Parameters:
comparator
- to sort this collection- Returns:
- this
-
at
- Specified by:
at
in interfaceXGettingSequence<E>
- Specified by:
at
in interfaceXReferencing<E>
-
first
E 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>
- Specified by:
first
in interfaceXReferencing<E>
- Returns:
- First element
-
last
E last()Description copied from interface:XGettingSequence
Gets last element or throwsIndexOutOfBoundsException
if the collection is empty.- Specified by:
last
in interfaceXGettingSequence<E>
- Specified by:
last
in interfaceXReferencing<E>
- Returns:
- Last element
-
poll
E poll()Description copied from interface:XGettingSequence
Gets first element or null if the collection is empty.- Specified by:
poll
in interfaceXGettingSequence<E>
- Specified by:
poll
in interfaceXReferencing<E>
- Returns:
- First element or null
-
peek
E 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>
- Specified by:
peek
in interfaceXReferencing<E>
- Returns:
- Last element or null
-
maxIndex
- Specified by:
maxIndex
in interfaceXGettingSequence<E>
- Specified by:
maxIndex
in interfaceXReferencing<E>
-
minIndex
- Specified by:
minIndex
in interfaceXGettingSequence<E>
- Specified by:
minIndex
in interfaceXReferencing<E>
-
indexOf
- Specified by:
indexOf
in interfaceXGettingSequence<E>
- Specified by:
indexOf
in interfaceXReferencing<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>
- Specified by:
indexBy
in interfaceXReferencing<E>
- Parameters:
predicate
- to define a valid element- Returns:
- The index of the first positively tested element.
-
lastIndexOf
- Specified by:
lastIndexOf
in interfaceXGettingSequence<E>
- Specified by:
lastIndexOf
in interfaceXReferencing<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>
- Specified by:
lastIndexBy
in interfaceXReferencing<E>
- Parameters:
predicate
- to define a valid element- Returns:
- the index of the last positively tested element.
-
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>
- Specified by:
scan
in interfaceXReferencing<E>
- Parameters:
predicate
- to define a valid element- Returns:
- the index of the last positively tested element.
-
isSorted
Description copied from interface:XGettingSequence
Tests if the collection is sorted according to the given comparator.- Specified by:
isSorted
in interfaceXGettingSequence<E>
- Specified by:
isSorted
in interfaceXReferencing<E>
- Parameters:
comparator
- defines if elements are sorted- Returns:
- true if it sorted, false if not
-
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>
- Specified by:
copySelection
in interfaceXReferencing<E>
- Type Parameters:
T
- type of the target- Parameters:
target
- on which theConsumer.accept(Object)
is calledindices
- of the elements which are copied- Returns:
- Given target
-
iterator
- Specified by:
iterator
in interfaceIterable<E>
- Specified by:
iterator
in interfaceXGettingCollection<E>
- Specified by:
iterator
in interfaceXReferencing<E>
-
toArray
Object[] 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>
- Specified by:
toArray
in interfaceXReferencing<E>
- Returns:
- an array containing all of the elements in this collection
-
hasVolatileElements
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>
- Specified by:
hasVolatileElements
in interfaceXReferencing<E>
- Returns:
true
if the collection contains volatile elements.
-
size
long size()- Specified by:
size
in interfaceSized
- Specified by:
size
in interfaceXGettingCollection<E>
- Specified by:
size
in interfaceXReferencing<E>
-
isEmpty
boolean isEmpty()- Specified by:
isEmpty
in interfaceSized
- Specified by:
isEmpty
in interfaceXReferencing<E>
-
equality
- Specified by:
equality
in interfaceXGettingCollection<E>
- Specified by:
equality
in interfaceXReferencing<E>
-
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>
- Specified by:
toArray
in interfaceXReferencing<E>
- Returns:
- a typed array containing all of the elements in this collection
-
equals
- Specified by:
equals
in interfaceXGettingCollection<E>
- Specified by:
equals
in interfaceXReferencing<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
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>
- Specified by:
equalsContent
in interfaceXReferencing<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
-
nullContained
boolean nullContained()- Specified by:
nullContained
in interfaceXGettingCollection<E>
- Specified by:
nullContained
in interfaceXReferencing<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>
- Specified by:
containsId
in interfaceXReferencing<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>
- Specified by:
contains
in interfaceXReferencing<E>
- Parameters:
element
- to be searched in the collection- Returns:
- Whether this collection contains the given element as specified by the
Equalator
.
-
containsSearched
- Specified by:
containsSearched
in interfaceXGettingCollection<E>
- Specified by:
containsSearched
in interfaceXReferencing<E>
-
containsAll
- Specified by:
containsAll
in interfaceXGettingCollection<E>
- Specified by:
containsAll
in interfaceXReferencing<E>
- Parameters:
elements
- to be searched in the collection.- Returns:
- Whether this collection contains all given elements as specified by the
Equalator
.
-
applies
Description copied from interface:XGettingCollection
Tests each element of the collection on the given predicate.- Specified by:
applies
in interfaceXGettingCollection<E>
- Specified by:
applies
in interfaceXReferencing<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.
-
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>
- Specified by:
count
in interfaceXReferencing<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>
- Specified by:
countBy
in interfaceXReferencing<E>
- Parameters:
predicate
- defines which elements are counted and which are not- Returns:
- Amount of matches
-
search
Description copied from interface:XGettingCollection
Returns the first contained element matching the passed predicate.- Specified by:
search
in interfaceXGettingCollection<E>
- Specified by:
search
in interfaceXReferencing<E>
- Parameters:
predicate
- defines which element is searched- Returns:
- Matching element
-
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>
- Specified by:
seek
in interfaceXReferencing<E>
- Parameters:
sample
- to seek in the collection- Returns:
- the first contained element matching the passed sample
-
max
- Specified by:
max
in interfaceXGettingCollection<E>
- Specified by:
max
in interfaceXReferencing<E>
-
min
- Specified by:
min
in interfaceXGettingCollection<E>
- Specified by:
min
in interfaceXReferencing<E>
-
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>
- Specified by:
distinct
in interfaceXReferencing<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>
- Specified by:
distinct
in interfaceXReferencing<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
-
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>
- Specified by:
copyTo
in interfaceXReferencing<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>
- Specified by:
filterTo
in interfaceXReferencing<E>
- Parameters:
target
- on which theConsumer.accept(Object)
is called for elements that testtrue
.predicate
- on which to test all elements.- Returns:
- Given target
-
union
<T extends Consumer<? super E>> T union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T 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>
- Specified by:
union
in interfaceXReferencing<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
-
intersect
<T extends Consumer<? super E>> T intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T 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>
- Specified by:
intersect
in interfaceXReferencing<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
-
except
<T extends Consumer<? super E>> T except(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T 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>
- Specified by:
except
in interfaceXReferencing<E>
- Type Parameters:
T
- 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
-
nullAllowed
boolean nullAllowed()Description copied from interface:ExtendedCollection
Defines if null-elements are allowed inside the collection or not.- Specified by:
nullAllowed
in interfaceExtendedCollection<E>
- Specified by:
nullAllowed
in interfaceXReferencing<E>
- Returns:
true
if null is allowed inside the collection;false
if not
-
maximumCapacity
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
- Specified by:
maximumCapacity
in interfaceXReferencing<E>
- Returns:
- the maximum amount of elements this carrier instance can contain.
-
remainingCapacity
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
- Specified by:
remainingCapacity
in interfaceXReferencing<E>
-
isFull
boolean isFull()Description copied from interface:CapacityCarrying
Returns true if the current capacity cannot be increased any more.- Specified by:
isFull
in interfaceCapacityCarrying
- Specified by:
isFull
in interfaceXReferencing<E>
-
immure
Description copied from interface:XGettingList
Provides an instance of an immutable collection type with equal behavior and data as this instance.If this instance already is of an immutable collection type, it returns itself.
- Specified by:
immure
in interfaceXGettingBag<E>
- Specified by:
immure
in interfaceXGettingCollection<E>
- Specified by:
immure
in interfaceXGettingEnum<E>
- Specified by:
immure
in interfaceXGettingList<E>
- Specified by:
immure
in interfaceXGettingSequence<E>
- Specified by:
immure
in interfaceXGettingSet<E>
- Specified by:
immure
in interfaceXReferencing<E>
- Returns:
- an immutable copy of this collection instance.
-
listIterator
ListIterator<E> listIterator()- Specified by:
listIterator
in interfaceXGettingList<E>
- Specified by:
listIterator
in interfaceXReferencing<E>
-
listIterator
- Specified by:
listIterator
in interfaceXGettingList<E>
- Specified by:
listIterator
in interfaceXReferencing<E>
-
old
- Specified by:
old
in interfaceXGettingCollection<E>
- Specified by:
old
in interfaceXGettingList<E>
- Specified by:
old
in interfaceXReferencing<E>
-
copy
XReference<E> copy()Description copied from interface:XGettingSequence
Creates a true copy of this list which references the same elements in the same order as this list does at the time the method is called. The elements themselves are NOT copied (no deep copying).
The type of the returned list is the same as of this list if possible (i.e.: a SubList can not meaningful return a true copy that references its elements but still is a SubList)- Specified by:
copy
in interfaceCopyable
- Specified by:
copy
in interfaceXGettingBag<E>
- Specified by:
copy
in interfaceXGettingCollection<E>
- Specified by:
copy
in interfaceXGettingEnum<E>
- Specified by:
copy
in interfaceXGettingList<E>
- Specified by:
copy
in interfaceXGettingSequence<E>
- Specified by:
copy
in interfaceXGettingSet<E>
- Specified by:
copy
in interfaceXReferencing<E>
- Specified by:
copy
in interfaceXReplacingBag<E>
- Specified by:
copy
in interfaceXSettingList<E>
- Specified by:
copy
in interfaceXSettingSequence<E>
- Specified by:
copy
in interfaceXSortableEnum<E>
- Specified by:
copy
in interfaceXSortableSequence<E>
- Returns:
- a copy of this list
-
toReversed
XReference<E> 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 interfaceXGettingList<E>
- Specified by:
toReversed
in interfaceXGettingSequence<E>
- Specified by:
toReversed
in interfaceXReferencing<E>
- Specified by:
toReversed
in interfaceXSettingList<E>
- Specified by:
toReversed
in interfaceXSettingSequence<E>
- Specified by:
toReversed
in interfaceXSortableEnum<E>
- Specified by:
toReversed
in interfaceXSortableSequence<E>
- Returns:
- New copy of the collection
-
view
XReferencing<E> 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 interfaceXGettingBag<E>
- Specified by:
view
in interfaceXGettingCollection<E>
- Specified by:
view
in interfaceXGettingEnum<E>
- Specified by:
view
in interfaceXGettingList<E>
- Specified by:
view
in interfaceXGettingSequence<E>
- Specified by:
view
in interfaceXReferencing<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 interfaceXGettingList<E>
- Specified by:
view
in interfaceXGettingSequence<E>
- Specified by:
view
in interfaceXReferencing<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 interfaceXGettingList<E>
- Specified by:
range
in interfaceXGettingSequence<E>
- Specified by:
range
in interfaceXReferencing<E>
- Specified by:
range
in interfaceXSettingList<E>
- Specified by:
range
in interfaceXSettingSequence<E>
-