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 voidaccept(E element)booleanapplies(Predicate<? super E> predicate)Eat(long index)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)XReference<E>copy()Creates a true copy of this list which references th 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)<T extends Consumer<? super E>>
TcopyTo(T target)longcount(E element)longcountBy(Predicate<? super E> predicate)<T extends Consumer<? super E>>
Tdistinct(T target)<T extends Consumer<? super E>>
Tdistinct(T target, Equalator<? super E> equalator)Equalator<? super E>equality()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.<T extends Consumer<? super E>>
Texcept(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)XReference<E>fill(long offset, long length, E element)<T extends Consumer<? super E>>
TfilterTo(T target, Predicate<? super E> predicate)Efirst()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.Constant<E>immure()Provides an instance of an immutable collection type with equal behavior and data as this instance.longindexBy(Predicate<? super E> predicate)longindexOf(E element)<T extends Consumer<? super E>>
Tintersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)booleanisEmpty()booleanisFull()Returns true if the current capacity cannot be increased any more.booleanisSorted(Comparator<? super E> comparator)Iterator<E>iterator()Elast()longlastIndexBy(Predicate<? super E> predicate)longlastIndexOf(E element)ListIterator<E>listIterator()ListIterator<E>listIterator(long index)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.longmaxIndex(Comparator<? super E> comparator)Emin(Comparator<? super E> comparator)longminIndex(Comparator<? super E> comparator)booleannullAllowed()booleannullContained()OldList<E>old()Epeek()Epoll()XReference<E>range(long fromIndex, long toIndex)longremainingCapacity()Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.longreplace(E element, E replacement)longreplace(Predicate<? super E> predicate, E substitute)longreplaceAll(XGettingCollection<? extends E> elements, E replacement)booleanreplaceOne(E element, E replacement)booleanreplaceOne(Predicate<? super E> predicate, E substitute)XReference<E>reverse()longscan(Predicate<? super E> predicate)Iterates through the collection and returns the index of the last element that the passedPredicateapplied to ("scanning").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.booleanset(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)voidset(E element)XReference<E>setAll(long index, E... elements)voidsetFirst(E element)EsetGet(long index, E element)voidsetLast(E element)XReference<E>shiftBy(long sourceIndex, long distance)XReference<E>shiftBy(long sourceIndex, long distance, long length)XReference<E>shiftTo(long sourceIndex, long targetIndex)XReference<E>shiftTo(long sourceIndex, long targetIndex, long length)longsize()XReference<E>sort(Comparator<? super E> comparator)XReference<E>swap(long indexA, long indexB)XReference<E>swap(long indexA, long indexB, long length)Object[]toArray()E[]toArray(Class<E> type)XReference<E>toReversed()<T extends Consumer<? super E>>
Tunion(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)XReferencing<E>view()XReferencing<E>view(long lowIndex, long highIndex)Methods inherited from interface one.microstream.collections.types.XGettingCollection
equals, hashCode, intSize, join
-
Method Details
-
set
-
accept
-
replaceOne
- Specified by:
replaceOnein interfaceXReplacingBag<E>
-
replace
- Specified by:
replacein interfaceXReplacingBag<E>
-
replaceAll
- Specified by:
replaceAllin interfaceXReplacingBag<E>
-
replaceOne
- Specified by:
replaceOnein interfaceXReplacingBag<E>
-
replace
- Specified by:
replacein interfaceXReplacingBag<E>
-
set
- Specified by:
setin interfaceXSettingSequence<E>
-
setGet
- Specified by:
setGetin interfaceXSettingSequence<E>
-
setFirst
- Specified by:
setFirstin interfaceXSettingSequence<E>
-
setLast
- Specified by:
setLastin interfaceXSettingSequence<E>
-
shiftTo
- Specified by:
shiftToin interfaceXOrderingEnum<E>- Specified by:
shiftToin interfaceXOrderingSequence<E>- Specified by:
shiftToin interfaceXSortableEnum<E>- Specified by:
shiftToin interfaceXSortableSequence<E>
-
shiftTo
- Specified by:
shiftToin interfaceXOrderingEnum<E>- Specified by:
shiftToin interfaceXOrderingSequence<E>- Specified by:
shiftToin interfaceXSortableEnum<E>- Specified by:
shiftToin interfaceXSortableSequence<E>
-
shiftBy
- Specified by:
shiftByin interfaceXOrderingEnum<E>- Specified by:
shiftByin interfaceXOrderingSequence<E>- Specified by:
shiftByin interfaceXSortableEnum<E>- Specified by:
shiftByin interfaceXSortableSequence<E>
-
shiftBy
- Specified by:
shiftByin interfaceXOrderingEnum<E>- Specified by:
shiftByin interfaceXOrderingSequence<E>- Specified by:
shiftByin interfaceXSortableEnum<E>- Specified by:
shiftByin interfaceXSortableSequence<E>
-
setAll
- Specified by:
setAllin interfaceXSettingList<E>- Specified by:
setAllin interfaceXSettingSequence<E>
-
set
- Specified by:
setin interfaceXSettingList<E>- Specified by:
setin interfaceXSettingSequence<E>
-
set
- Specified by:
setin interfaceXSettingList<E>- Specified by:
setin interfaceXSettingSequence<E>
-
swap
- Specified by:
swapin interfaceXOrderingEnum<E>- Specified by:
swapin interfaceXOrderingSequence<E>- Specified by:
swapin interfaceXSettingList<E>- Specified by:
swapin interfaceXSettingSequence<E>- Specified by:
swapin interfaceXSortableEnum<E>- Specified by:
swapin interfaceXSortableSequence<E>
-
swap
- Specified by:
swapin interfaceXOrderingEnum<E>- Specified by:
swapin interfaceXOrderingSequence<E>- Specified by:
swapin interfaceXSettingList<E>- Specified by:
swapin interfaceXSettingSequence<E>- Specified by:
swapin interfaceXSortableEnum<E>- Specified by:
swapin interfaceXSortableSequence<E>
-
reverse
XReference<E> reverse()- Specified by:
reversein interfaceXOrderingEnum<E>- Specified by:
reversein interfaceXOrderingSequence<E>- Specified by:
reversein interfaceXSettingList<E>- Specified by:
reversein interfaceXSettingSequence<E>- Specified by:
reversein interfaceXSortableEnum<E>- Specified by:
reversein interfaceXSortableSequence<E>
-
fill
- Specified by:
fillin interfaceXSettingList<E>
-
sort
- Specified by:
sortin interfaceSortable<E>- Specified by:
sortin interfaceXSettingList<E>- Specified by:
sortin interfaceXSettingSequence<E>- Specified by:
sortin interfaceXSortableEnum<E>- Specified by:
sortin interfaceXSortableSequence<E>
-
at
- Specified by:
atin interfaceXGettingSequence<E>- Specified by:
atin interfaceXReferencing<E>
-
first
E first()- Specified by:
firstin interfaceXGettingSequence<E>- Specified by:
firstin interfaceXReferencing<E>
-
last
E last()- Specified by:
lastin interfaceXGettingSequence<E>- Specified by:
lastin interfaceXReferencing<E>
-
poll
E poll()- Specified by:
pollin interfaceXGettingSequence<E>- Specified by:
pollin interfaceXReferencing<E>
-
peek
E peek()- Specified by:
peekin interfaceXGettingSequence<E>- Specified by:
peekin interfaceXReferencing<E>
-
maxIndex
- Specified by:
maxIndexin interfaceXGettingSequence<E>- Specified by:
maxIndexin interfaceXReferencing<E>
-
minIndex
- Specified by:
minIndexin interfaceXGettingSequence<E>- Specified by:
minIndexin interfaceXReferencing<E>
-
indexOf
- Specified by:
indexOfin interfaceXGettingSequence<E>- Specified by:
indexOfin interfaceXReferencing<E>
-
indexBy
- Specified by:
indexByin interfaceXGettingSequence<E>- Specified by:
indexByin interfaceXReferencing<E>
-
lastIndexOf
- Specified by:
lastIndexOfin interfaceXGettingSequence<E>- Specified by:
lastIndexOfin interfaceXReferencing<E>
-
lastIndexBy
- Specified by:
lastIndexByin interfaceXGettingSequence<E>- Specified by:
lastIndexByin interfaceXReferencing<E>
-
scan
Description copied from interface:XGettingSequenceIterates through the collection and returns the index of the last element that the passedPredicateapplied to ("scanning").- Specified by:
scanin interfaceXGettingSequence<E>- Specified by:
scanin interfaceXReferencing<E>- Returns:
- the index of the last positively tested element.
-
isSorted
- Specified by:
isSortedin interfaceXGettingSequence<E>- Specified by:
isSortedin interfaceXReferencing<E>
-
copySelection
- Specified by:
copySelectionin interfaceXGettingSequence<E>- Specified by:
copySelectionin interfaceXReferencing<E>
-
iterator
- Specified by:
iteratorin interfaceIterable<E>- Specified by:
iteratorin interfaceXGettingCollection<E>- Specified by:
iteratorin interfaceXReferencing<E>
-
toArray
Object[] toArray()- Specified by:
toArrayin interfaceXGettingCollection<E>- Specified by:
toArrayin interfaceXReferencing<E>
-
hasVolatileElements
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>- Specified by:
hasVolatileElementsin interfaceXReferencing<E>- Returns:
trueif the collection contains volatile elements.
-
size
long size()- Specified by:
sizein interfaceSized- Specified by:
sizein interfaceXGettingCollection<E>- Specified by:
sizein interfaceXReferencing<E>
-
isEmpty
boolean isEmpty()- Specified by:
isEmptyin interfaceSized- Specified by:
isEmptyin interfaceXReferencing<E>
-
equality
- Specified by:
equalityin interfaceXGettingCollection<E>- Specified by:
equalityin interfaceXReferencing<E>
-
toArray
- Specified by:
toArrayin interfaceXGettingCollection<E>- Specified by:
toArrayin interfaceXReferencing<E>
-
equals
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>- Specified by:
equalsin interfaceXReferencing<E>
-
equalsContent
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>- Specified by:
equalsContentin interfaceXReferencing<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
-
nullContained
boolean nullContained()- Specified by:
nullContainedin interfaceXGettingCollection<E>- Specified by:
nullContainedin interfaceXReferencing<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>- Specified by:
containsIdin interfaceXReferencing<E>- Parameters:
element- the element to be searched in the collection by identity.- Returns:
- whether this collection contains exactely the given element.
-
contains
- Specified by:
containsin interfaceXGettingCollection<E>- Specified by:
containsin interfaceXReferencing<E>
-
containsSearched
- Specified by:
containsSearchedin interfaceXGettingCollection<E>- Specified by:
containsSearchedin interfaceXReferencing<E>
-
containsAll
- Specified by:
containsAllin interfaceXGettingCollection<E>- Specified by:
containsAllin interfaceXReferencing<E>
-
applies
- Specified by:
appliesin interfaceXGettingCollection<E>- Specified by:
appliesin interfaceXReferencing<E>
-
count
- Specified by:
countin interfaceXGettingCollection<E>- Specified by:
countin interfaceXReferencing<E>
-
countBy
- Specified by:
countByin interfaceXGettingCollection<E>- Specified by:
countByin interfaceXReferencing<E>
-
search
- Specified by:
searchin interfaceXGettingCollection<E>- Specified by:
searchin interfaceXReferencing<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>- Specified by:
seekin interfaceXReferencing<E>
-
max
- Specified by:
maxin interfaceXGettingCollection<E>- Specified by:
maxin interfaceXReferencing<E>
-
min
- Specified by:
minin interfaceXGettingCollection<E>- Specified by:
minin interfaceXReferencing<E>
-
distinct
- Specified by:
distinctin interfaceXGettingCollection<E>- Specified by:
distinctin interfaceXReferencing<E>
-
distinct
- Specified by:
distinctin interfaceXGettingCollection<E>- Specified by:
distinctin interfaceXReferencing<E>
-
copyTo
- Specified by:
copyToin interfaceXGettingCollection<E>- Specified by:
copyToin interfaceXReferencing<E>
-
filterTo
- Specified by:
filterToin interfaceXGettingCollection<E>- Specified by:
filterToin interfaceXReferencing<E>
-
union
<T extends Consumer<? super E>> T union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)- Specified by:
unionin interfaceXGettingCollection<E>- Specified by:
unionin interfaceXReferencing<E>
-
intersect
<T extends Consumer<? super E>> T intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)- Specified by:
intersectin interfaceXGettingCollection<E>- Specified by:
intersectin interfaceXReferencing<E>
-
except
<T extends Consumer<? super E>> T except(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)- Specified by:
exceptin interfaceXGettingCollection<E>- Specified by:
exceptin interfaceXReferencing<E>
-
nullAllowed
boolean nullAllowed()- Specified by:
nullAllowedin interfaceExtendedCollection<E>- Specified by:
nullAllowedin interfaceXReferencing<E>
-
maximumCapacity
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- Specified by:
maximumCapacityin interfaceXReferencing<E>- Returns:
- the maximum amount of elements this carrier instance can contain.
-
remainingCapacity
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- Specified by:
remainingCapacityin interfaceXReferencing<E>
-
isFull
boolean isFull()Description copied from interface:CapacityCarryingReturns true if the current capacity cannot be increased any more.- Specified by:
isFullin interfaceCapacityCarrying- Specified by:
isFullin interfaceXReferencing<E>
-
immure
Description copied from interface:XGettingListProvides 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 interfaceXGettingBag<E>- Specified by:
immurein interfaceXGettingCollection<E>- Specified by:
immurein interfaceXGettingEnum<E>- Specified by:
immurein interfaceXGettingList<E>- Specified by:
immurein interfaceXGettingSequence<E>- Specified by:
immurein interfaceXGettingSet<E>- Specified by:
immurein interfaceXReferencing<E>- Returns:
- an immutable copy of this collection instance.
-
listIterator
ListIterator<E> listIterator()- Specified by:
listIteratorin interfaceXGettingList<E>- Specified by:
listIteratorin interfaceXReferencing<E>
-
listIterator
- Specified by:
listIteratorin interfaceXGettingList<E>- Specified by:
listIteratorin interfaceXReferencing<E>
-
old
- Specified by:
oldin interfaceXGettingCollection<E>- Specified by:
oldin interfaceXGettingList<E>- Specified by:
oldin interfaceXReferencing<E>
-
copy
XReference<E> copy()Description copied from interface:XGettingSequenceCreates a true copy of this list which references th 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:
copyin interfaceCopyable- Specified by:
copyin interfaceXGettingBag<E>- Specified by:
copyin interfaceXGettingCollection<E>- Specified by:
copyin interfaceXGettingEnum<E>- Specified by:
copyin interfaceXGettingList<E>- Specified by:
copyin interfaceXGettingSequence<E>- Specified by:
copyin interfaceXGettingSet<E>- Specified by:
copyin interfaceXReferencing<E>- Specified by:
copyin interfaceXReplacingBag<E>- Specified by:
copyin interfaceXSettingList<E>- Specified by:
copyin interfaceXSettingSequence<E>- Specified by:
copyin interfaceXSortableEnum<E>- Specified by:
copyin interfaceXSortableSequence<E>- Returns:
- a copy of this list
-
toReversed
XReference<E> toReversed()- Specified by:
toReversedin interfaceXGettingEnum<E>- Specified by:
toReversedin interfaceXGettingList<E>- Specified by:
toReversedin interfaceXGettingSequence<E>- Specified by:
toReversedin interfaceXReferencing<E>- Specified by:
toReversedin interfaceXSettingList<E>- Specified by:
toReversedin interfaceXSettingSequence<E>- Specified by:
toReversedin interfaceXSortableEnum<E>- Specified by:
toReversedin interfaceXSortableSequence<E>
-
view
XReferencing<E> view()- Specified by:
viewin interfaceXGettingBag<E>- Specified by:
viewin interfaceXGettingCollection<E>- Specified by:
viewin interfaceXGettingEnum<E>- Specified by:
viewin interfaceXGettingList<E>- Specified by:
viewin interfaceXGettingSequence<E>- Specified by:
viewin interfaceXReferencing<E>
-
view
- Specified by:
viewin interfaceXGettingEnum<E>- Specified by:
viewin interfaceXGettingList<E>- Specified by:
viewin interfaceXGettingSequence<E>- Specified by:
viewin interfaceXReferencing<E>
-
range
- Specified by:
rangein interfaceXGettingEnum<E>- Specified by:
rangein interfaceXGettingList<E>- Specified by:
rangein interfaceXGettingSequence<E>- Specified by:
rangein interfaceXReferencing<E>- Specified by:
rangein interfaceXSettingList<E>- Specified by:
rangein interfaceXSettingSequence<E>
-