Class ListAccessor<E>
- All Implemented Interfaces:
Iterable<E>,CapacityCarrying,ExtendedBag<E>,ExtendedCollection<E>,ExtendedList<E>,ExtendedSequence<E>,ReleasingCollection<E>,Sized,Sortable<E>,XGettingBag<E>,XGettingCollection<E>,XGettingList<E>,XGettingSequence<E>,XIndexIterable<E>,XIterable<E>,XJoinable<E>,XOrderingSequence<E>,XReplacingBag<E>,XReplacingCollection<E>,XSettingList<E>,XSettingSequence<E>,XSortableSequence<E>,Copyable
public class ListAccessor<E> extends Object implements XSettingList<E>
XSettingList to only those ofXSettingList, effectively making the wrapped XSettingList instance structural unmodifiable
if used through an instance of this class.
All methods declared in XSettingList are transparently passed to the wrapped list.
All structural modifying methods declared in Collection and List(all variations of add~(), remove~() and retain~() as well as clear()) immediately throw an UnsupportedOperationException when called.
This concept can be very useful if a class wants to provide public read and write access to an internal list without either the danger of the list being structurally modified from the outside or the need to copy the whole list on every access.
This is one of many useful concepts that are missing in the JDK Collections Framework and thus so far lead to either inefficient or unneccessary verbose program code (or both).
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListAccessor.OldListAccessor<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> -
Constructor Summary
Constructors Constructor Description ListAccessor(XSettingList<E> list) -
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)ListAccessor<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)<C extends Consumer<? super E>>
CcopyTo(C target)longcount(E element)longcountBy(Predicate<? super E> predicate)<C extends Consumer<? super E>>
Cdistinct(C target)<C extends Consumer<? super E>>
Cdistinct(C target, Equalator<? super E> equalator)Equalator<? super E>equality()booleanequals(Object o)Deprecated.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.<C extends Consumer<? super E>>
Cexcept(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)ListAccessor<E>fill(long offset, long length, E element)<C extends Consumer<? super E>>
CfilterTo(C target, Predicate<? super E> predicate)Efirst()Eget()Gets one element from the collection.inthashCode()Deprecated.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.XImmutableList<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)<C extends Consumer<? super E>>
Cintersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)booleanisEmpty()booleanisFull()Returns true if the current capacity cannot be increased any more.booleanisSorted(Comparator<? super E> comparator)<P extends Consumer<? super E>>
Piterate(P procedure)<P extends IndexedAcceptor<? super E>>
PiterateIndexed(P procedure)Iterator<E>iterator()<A> Ajoin(BiConsumer<? super E,? super A> joiner, A aggregate)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()ListAccessor.OldListAccessor<E>old()Epeek()Epoll()XSettingList<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)ListAccessor<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)ListAccessor<E>set(long offset, E[] src, int srcIndex, int srcLength)ListAccessor<E>set(long offset, XGettingSequence<? extends E> elements, long elementsOffset, long elementsLength)ListAccessor<E>setAll(long offset, E... elements)voidsetFirst(E element)EsetGet(long index, E element)voidsetLast(E element)ListAccessor<E>shiftBy(long sourceIndex, long distance)ListAccessor<E>shiftBy(long sourceIndex, long distance, long length)ListAccessor<E>shiftTo(long sourceIndex, long targetIndex)ListAccessor<E>shiftTo(long sourceIndex, long targetIndex, long length)longsize()ListAccessor<E>sort(Comparator<? super E> comparator)longsubstitute(Function<? super E,? extends E> mapper)longsubstitute(Predicate<? super E> predicate, Function<E,E> mapper)ListAccessor<E>swap(long indexA, long indexB)ListAccessor<E>swap(long indexA, long indexB, long length)Object[]toArray()E[]toArray(Class<E> type)ListAccessor<E>toReversed()<C extends Consumer<? super E>>
Cunion(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)ListView<E>view()SubListView<E>view(long fromIndex, long toIndex)
-
Constructor Details
-
Method Details
-
equality
- Specified by:
equalityin interfaceXGettingCollection<E>
-
hasVolatileElements
public final 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.
-
containsSearched
- Specified by:
containsSearchedin interfaceXGettingCollection<E>
-
applies
- Specified by:
appliesin interfaceXGettingCollection<E>
-
nullAllowed
public final boolean nullAllowed()- Specified by:
nullAllowedin interfaceExtendedCollection<E>
-
nullContained
public final boolean nullContained()- Specified by:
nullContainedin interfaceXGettingCollection<E>
-
containsAll
- Specified by:
containsAllin interfaceXGettingCollection<E>
-
contains
- Specified by:
containsin 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.
-
copy
Description copied from interface:XGettingCollectionCreates 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:
copyin interfaceCopyable- Specified by:
copyin interfaceXGettingBag<E>- Specified by:
copyin interfaceXGettingCollection<E>- Specified by:
copyin interfaceXGettingList<E>- Specified by:
copyin interfaceXGettingSequence<E>- Specified by:
copyin interfaceXReplacingBag<E>- Specified by:
copyin interfaceXSettingList<E>- Specified by:
copyin interfaceXSettingSequence<E>- Specified by:
copyin interfaceXSortableSequence<E>- Returns:
- a copy of this list
-
filterTo
- Specified by:
filterToin interfaceXGettingCollection<E>
-
copyTo
- Specified by:
copyToin interfaceXGettingCollection<E>
-
count
- Specified by:
countin interfaceXGettingCollection<E>
-
countBy
- Specified by:
countByin interfaceXGettingCollection<E>
-
distinct
- Specified by:
distinctin interfaceXGettingCollection<E>
-
distinct
- Specified by:
distinctin interfaceXGettingCollection<E>
-
equals
Deprecated.Description copied from interface:XGettingCollectionPerforms 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 asCollectiondefines 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:
equalsin interfaceXGettingCollection<E>- Overrides:
equalsin classObject
-
equals
public final boolean equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)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
public final boolean equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)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
-
except
public final <C extends Consumer<? super E>> C except(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)- Specified by:
exceptin interfaceXGettingCollection<E>
-
iterate
-
iterateIndexed
- Specified by:
iterateIndexedin interfaceXIndexIterable<E>
-
join
-
fill
- Specified by:
fillin interfaceXSettingList<E>
-
at
- Specified by:
atin interfaceXGettingSequence<E>
-
get
Description copied from interface:XGettingCollectionGets 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:
getin interfaceXGettingCollection<E>- Specified by:
getin interfaceXGettingSequence<E>- Returns:
- the first / any element.
- See Also:
XGettingSequence.at(long),XGettingSequence.first(),XGettingSequence.last()
-
first
- Specified by:
firstin interfaceXGettingSequence<E>
-
last
- Specified by:
lastin interfaceXGettingSequence<E>
-
poll
- Specified by:
pollin interfaceXGettingSequence<E>
-
peek
- Specified by:
peekin interfaceXGettingSequence<E>
-
hashCode
Deprecated.- Specified by:
hashCodein interfaceXGettingCollection<E>- Overrides:
hashCodein classObject
-
indexBy
- Specified by:
indexByin interfaceXGettingSequence<E>
-
indexOf
- Specified by:
indexOfin interfaceXGettingSequence<E>
-
intersect
public final <C extends Consumer<? super E>> C intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)- Specified by:
intersectin interfaceXGettingCollection<E>
-
isEmpty
public final boolean isEmpty() -
isSorted
- Specified by:
isSortedin interfaceXGettingSequence<E>
-
lastIndexBy
- Specified by:
lastIndexByin interfaceXGettingSequence<E>
-
lastIndexOf
- Specified by:
lastIndexOfin interfaceXGettingSequence<E>
-
iterator
-
listIterator
- Specified by:
listIteratorin interfaceXGettingList<E>
-
listIterator
- Specified by:
listIteratorin interfaceXGettingList<E>
-
max
- Specified by:
maxin interfaceXGettingCollection<E>
-
maxIndex
- Specified by:
maxIndexin interfaceXGettingSequence<E>
-
min
- Specified by:
minin interfaceXGettingCollection<E>
-
minIndex
- Specified by:
minIndexin interfaceXGettingSequence<E>
-
replace
- Specified by:
replacein interfaceXReplacingBag<E>
-
replace
- Specified by:
replacein interfaceXReplacingBag<E>
-
substitute
- Specified by:
substitutein interfaceXReplacingCollection<E>
-
substitute
- Specified by:
substitutein interfaceXReplacingBag<E>
-
replaceAll
- Specified by:
replaceAllin interfaceXReplacingBag<E>
-
replaceOne
- Specified by:
replaceOnein interfaceXReplacingBag<E>
-
replaceOne
- Specified by:
replaceOnein interfaceXReplacingBag<E>
-
reverse
- Specified by:
reversein interfaceXOrderingSequence<E>- Specified by:
reversein interfaceXSettingList<E>- Specified by:
reversein interfaceXSettingSequence<E>- Specified by:
reversein interfaceXSortableSequence<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.
-
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>
-
search
- Specified by:
searchin interfaceXGettingCollection<E>
-
setAll
- Specified by:
setAllin interfaceXSettingList<E>- Specified by:
setAllin interfaceXSettingSequence<E>
-
set
- Specified by:
setin interfaceXSettingSequence<E>
-
setGet
- Specified by:
setGetin interfaceXSettingSequence<E>
-
set
- Specified by:
setin interfaceXSettingList<E>- Specified by:
setin interfaceXSettingSequence<E>
-
set
public final ListAccessor<E> set(long offset, XGettingSequence<? extends E> elements, long elementsOffset, long elementsLength)- Specified by:
setin interfaceXSettingList<E>- Specified by:
setin interfaceXSettingSequence<E>
-
setFirst
- Specified by:
setFirstin interfaceXSettingSequence<E>
-
setLast
- Specified by:
setLastin interfaceXSettingSequence<E>
-
size
public final long size()- Specified by:
sizein interfaceSized- Specified by:
sizein interfaceXGettingCollection<E>
-
maximumCapacity
public final long maximumCapacity()Description copied from interface:CapacityCarryingReturns the maximum amount of elements this carrier instance can contain.
The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g.Integer.MAX_VALUE)- Specified by:
maximumCapacityin interfaceCapacityCarrying- Returns:
- the maximum amount of elements this carrier instance can contain.
-
isFull
public final boolean isFull()Description copied from interface:CapacityCarryingReturns true if the current capacity cannot be increased any more.- Specified by:
isFullin interfaceCapacityCarrying
-
remainingCapacity
public final 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
-
sort
- Specified by:
sortin interfaceSortable<E>- Specified by:
sortin interfaceXSettingList<E>- Specified by:
sortin interfaceXSettingSequence<E>- Specified by:
sortin interfaceXSortableSequence<E>
-
range
- Specified by:
rangein interfaceXGettingList<E>- Specified by:
rangein interfaceXGettingSequence<E>- Specified by:
rangein interfaceXSettingList<E>- Specified by:
rangein interfaceXSettingSequence<E>
-
view
- Specified by:
viewin interfaceXGettingBag<E>- Specified by:
viewin interfaceXGettingCollection<E>- Specified by:
viewin interfaceXGettingList<E>- Specified by:
viewin interfaceXGettingSequence<E>
-
view
- Specified by:
viewin interfaceXGettingList<E>- Specified by:
viewin interfaceXGettingSequence<E>
-
shiftTo
- Specified by:
shiftToin interfaceXOrderingSequence<E>- Specified by:
shiftToin interfaceXSortableSequence<E>
-
shiftTo
- Specified by:
shiftToin interfaceXOrderingSequence<E>- Specified by:
shiftToin interfaceXSortableSequence<E>
-
shiftBy
- Specified by:
shiftByin interfaceXOrderingSequence<E>- Specified by:
shiftByin interfaceXSortableSequence<E>
-
shiftBy
- Specified by:
shiftByin interfaceXOrderingSequence<E>- Specified by:
shiftByin interfaceXSortableSequence<E>
-
swap
- Specified by:
swapin interfaceXOrderingSequence<E>- Specified by:
swapin interfaceXSettingList<E>- Specified by:
swapin interfaceXSettingSequence<E>- Specified by:
swapin interfaceXSortableSequence<E>
-
swap
- Specified by:
swapin interfaceXOrderingSequence<E>- Specified by:
swapin interfaceXSettingList<E>- Specified by:
swapin interfaceXSettingSequence<E>- Specified by:
swapin interfaceXSortableSequence<E>
-
toArray
- Specified by:
toArrayin interfaceXGettingCollection<E>
-
toArray
- Specified by:
toArrayin interfaceXGettingCollection<E>
-
toReversed
- Specified by:
toReversedin interfaceXGettingList<E>- Specified by:
toReversedin interfaceXGettingSequence<E>- Specified by:
toReversedin interfaceXSettingList<E>- Specified by:
toReversedin interfaceXSettingSequence<E>- Specified by:
toReversedin interfaceXSortableSequence<E>
-
union
public final <C extends Consumer<? super E>> C union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)- Specified by:
unionin interfaceXGettingCollection<E>
-
copySelection
- Specified by:
copySelectionin interfaceXGettingSequence<E>
-
immure
Description copied from interface:XGettingCollectionProvides 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 interfaceXGettingList<E>- Specified by:
immurein interfaceXGettingSequence<E>- Returns:
- an immutable copy of this collection instance.
-
old
- Specified by:
oldin interfaceXGettingCollection<E>- Specified by:
oldin interfaceXGettingList<E>
-