Interface XReferencing<E>
- All Superinterfaces:
CapacityCarrying,Copyable,ExtendedBag<E>,ExtendedCollection<E>,ExtendedList<E>,ExtendedSequence<E>,Iterable<E>,Referencing<E>,Sized,XGettingBag<E>,XGettingCollection<E>,XGettingEnum<E>,XGettingList<E>,XGettingSequence<E>,XGettingSet<E>,XIndexIterable<E>,XIterable<E>,XJoinable<E>
- All Known Subinterfaces:
XReference<E>
- All Known Implementing Classes:
Constant,LinkingReferencing.Default,LinkReference.Default,Single,Singleton,SingletonView
public interface XReferencing<E> extends XGettingList<E>, XGettingEnum<E>, Referencing<E>
-
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> -
Method Summary
Modifier and Type Method Description 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)XReferencing<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)<T extends Consumer<? super E>>
TfilterTo(T target, Predicate<? super E> predicate)Efirst()Eget()Gets the first element in the collection.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()XReferencing<E>range(long fromIndex, long toIndex)longremainingCapacity()Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.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.longsize()Object[]toArray()E[]toArray(Class<E> type)XReferencing<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
-
get
E get()Description copied from interface:XGettingSequenceGets the first element in the collection. This is a parameterless alias vorat(0).first() is an alias for this method for consistency reasons with last().- Specified by:
getin interfaceReferencing<E>- Specified by:
getin interfaceXGettingCollection<E>- Specified by:
getin interfaceXGettingSequence<E>- Returns:
- the first element.
- See Also:
XGettingSequence.at(long),XGettingSequence.first(),XGettingSequence.last()
-
at
- Specified by:
atin interfaceXGettingSequence<E>
-
first
E first()- Specified by:
firstin interfaceXGettingSequence<E>
-
last
E last()- Specified by:
lastin interfaceXGettingSequence<E>
-
poll
E poll()- Specified by:
pollin interfaceXGettingSequence<E>
-
peek
E peek()- Specified by:
peekin interfaceXGettingSequence<E>
-
maxIndex
- Specified by:
maxIndexin interfaceXGettingSequence<E>
-
minIndex
- Specified by:
minIndexin interfaceXGettingSequence<E>
-
indexOf
- Specified by:
indexOfin interfaceXGettingSequence<E>
-
indexBy
- Specified by:
indexByin interfaceXGettingSequence<E>
-
lastIndexOf
- Specified by:
lastIndexOfin interfaceXGettingSequence<E>
-
lastIndexBy
- Specified by:
lastIndexByin interfaceXGettingSequence<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>- Returns:
- the index of the last positively tested element.
-
isSorted
- Specified by:
isSortedin interfaceXGettingSequence<E>
-
copySelection
- Specified by:
copySelectionin interfaceXGettingSequence<E>
-
iterator
-
toArray
Object[] toArray()- Specified by:
toArrayin interfaceXGettingCollection<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>- Returns:
trueif the collection contains volatile elements.
-
size
long size()- Specified by:
sizein interfaceSized- Specified by:
sizein interfaceXGettingCollection<E>
-
isEmpty
boolean isEmpty() -
equality
- Specified by:
equalityin interfaceXGettingCollection<E>
-
toArray
- Specified by:
toArrayin interfaceXGettingCollection<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>
-
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>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>
-
containsId
Description copied from interface:XGettingCollectionSpecial version of contains() that guarantees to use identity comparison (" == ") when searching for the given element regardless of the collection's internal logic.
This method has the same behavior asXGettingCollection.containsSearched(Predicate)with aPredicateimplementation that checks for object identity. The only difference is a performance and usability advantage- Specified by:
containsIdin interfaceXGettingCollection<E>- Parameters:
element- the element to be searched in the collection by identity.- Returns:
- whether this collection contains exactely the given element.
-
contains
- Specified by:
containsin interfaceXGettingCollection<E>
-
containsSearched
- Specified by:
containsSearchedin interfaceXGettingCollection<E>
-
containsAll
- Specified by:
containsAllin interfaceXGettingCollection<E>
-
applies
- Specified by:
appliesin interfaceXGettingCollection<E>
-
count
- Specified by:
countin interfaceXGettingCollection<E>
-
countBy
- Specified by:
countByin interfaceXGettingCollection<E>
-
search
- Specified by:
searchin interfaceXGettingCollection<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>
-
max
- Specified by:
maxin interfaceXGettingCollection<E>
-
min
- Specified by:
minin interfaceXGettingCollection<E>
-
distinct
- Specified by:
distinctin interfaceXGettingCollection<E>
-
distinct
- Specified by:
distinctin interfaceXGettingCollection<E>
-
copyTo
- Specified by:
copyToin interfaceXGettingCollection<E>
-
filterTo
- Specified by:
filterToin interfaceXGettingCollection<E>
-
union
<T extends Consumer<? super E>> T union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)- Specified by:
unionin interfaceXGettingCollection<E>
-
intersect
<T extends Consumer<? super E>> T intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)- Specified by:
intersectin interfaceXGettingCollection<E>
-
except
<T extends Consumer<? super E>> T except(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)- Specified by:
exceptin interfaceXGettingCollection<E>
-
nullAllowed
boolean nullAllowed()- Specified by:
nullAllowedin interfaceExtendedCollection<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- 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
-
isFull
boolean isFull()Description copied from interface:CapacityCarryingReturns true if the current capacity cannot be increased any more.- Specified by:
isFullin interfaceCapacityCarrying
-
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>- Returns:
- an immutable copy of this collection instance.
-
listIterator
ListIterator<E> listIterator()- Specified by:
listIteratorin interfaceXGettingList<E>
-
listIterator
- Specified by:
listIteratorin interfaceXGettingList<E>
-
old
- Specified by:
oldin interfaceXGettingCollection<E>- Specified by:
oldin interfaceXGettingList<E>
-
copy
XReferencing<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>- Returns:
- a copy of this list
-
toReversed
XReferencing<E> toReversed()- Specified by:
toReversedin interfaceXGettingEnum<E>- Specified by:
toReversedin interfaceXGettingList<E>- Specified by:
toReversedin interfaceXGettingSequence<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>
-
view
- Specified by:
viewin interfaceXGettingEnum<E>- Specified by:
viewin interfaceXGettingList<E>- Specified by:
viewin interfaceXGettingSequence<E>
-
range
- Specified by:
rangein interfaceXGettingEnum<E>- Specified by:
rangein interfaceXGettingList<E>- Specified by:
rangein interfaceXGettingSequence<E>
-