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 class
ListAccessor.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 boolean
applies(Predicate<? super E> predicate)
E
at(long index)
boolean
contains(E element)
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)
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)
long
count(E element)
long
countBy(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()
boolean
equals(Object o)
Deprecated.boolean
equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
Returnstrue
if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)
yieldstrue
.boolean
equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
Returnstrue
if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.<C extends Consumer<? super E>>
Cexcept(XGettingCollection<? extends E> 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)
E
first()
E
get()
Gets one element from the collection.int
hashCode()
Deprecated.boolean
hasVolatileElements()
Tells if this collection contains volatile elements.
An element is volatile, if it can become no longer reachable by the collection without being removed from the collection.XImmutableList<E>
immure()
Provides an instance of an immutable collection type with equal behavior and data as this instance.long
indexBy(Predicate<? super E> predicate)
long
indexOf(E element)
<C extends Consumer<? super E>>
Cintersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)
boolean
isEmpty()
boolean
isFull()
Returns true if the current capacity cannot be increased any more.boolean
isSorted(Comparator<? super E> comparator)
<P extends Consumer<? super E>>
Piterate(P procedure)
<P extends IndexedAcceptor<? super E>>
PiterateIndexed(P procedure)
Iterator<E>
iterator()
<A> A
join(BiConsumer<? super E,? super A> joiner, A aggregate)
E
last()
long
lastIndexBy(Predicate<? super E> predicate)
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()
boolean
nullContained()
ListAccessor.OldListAccessor<E>
old()
E
peek()
E
poll()
XSettingList<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)
boolean
replaceOne(Predicate<? super E> predicate, E substitute)
ListAccessor<E>
reverse()
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)
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)
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)
void
setFirst(E element)
E
setGet(long index, E element)
void
setLast(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)
long
size()
ListAccessor<E>
sort(Comparator<? super E> comparator)
long
substitute(Function<? super E,? extends E> mapper)
long
substitute(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:
equality
in interfaceXGettingCollection<E>
-
hasVolatileElements
public final boolean hasVolatileElements()Description copied from interface:XGettingCollection
Tells if this collection contains volatile elements.
An element is volatile, if it can become no longer reachable by the collection without being removed from the collection. Examples areWeakReference
ofSoftReference
or implementations of collection entries that remove the element contained in an entry by some means outside the collection.
Note thatWeakReference
instances that are added to a a simple (non-volatile) implementation of a collection do NOT make the collection volatile, as the elements themselves (the reference instances) are still strongly referenced.- Specified by:
hasVolatileElements
in interfaceExtendedCollection<E>
- Specified by:
hasVolatileElements
in interfaceXGettingCollection<E>
- Returns:
true
if the collection contains volatile elements.
-
containsSearched
- Specified by:
containsSearched
in interfaceXGettingCollection<E>
-
applies
- Specified by:
applies
in interfaceXGettingCollection<E>
-
nullAllowed
public final boolean nullAllowed()- Specified by:
nullAllowed
in interfaceExtendedCollection<E>
-
nullContained
public final boolean nullContained()- Specified by:
nullContained
in interfaceXGettingCollection<E>
-
containsAll
- Specified by:
containsAll
in interfaceXGettingCollection<E>
-
contains
- Specified by:
contains
in interfaceXGettingCollection<E>
-
containsId
Description copied from interface:XGettingCollection
Special version of contains() that guarantees to use identity comparison (" == ") when searching for the given element regardless of the collection's internal logic.
This method has the same behavior asXGettingCollection.containsSearched(Predicate)
with aPredicate
implementation that checks for object identity. The only difference is a performance and usability advantage- Specified by:
containsId
in interfaceXGettingCollection<E>
- Parameters:
element
- the element to be searched in the collection by identity.- Returns:
- whether this collection contains exactely the given element.
-
copy
Description copied from interface:XGettingCollection
Creates a true copy of this collection which references the same elements as this collection does at the time the method is called. The elements themselves are NOT copied (no deep copying).
The type of the returned set is the same as of this list if possible.- Specified by:
copy
in interfaceCopyable
- Specified by:
copy
in interfaceXGettingBag<E>
- Specified by:
copy
in interfaceXGettingCollection<E>
- Specified by:
copy
in interfaceXGettingList<E>
- Specified by:
copy
in interfaceXGettingSequence<E>
- Specified by:
copy
in interfaceXReplacingBag<E>
- Specified by:
copy
in interfaceXSettingList<E>
- Specified by:
copy
in interfaceXSettingSequence<E>
- Specified by:
copy
in interfaceXSortableSequence<E>
- Returns:
- a copy of this list
-
filterTo
- Specified by:
filterTo
in interfaceXGettingCollection<E>
-
copyTo
- Specified by:
copyTo
in interfaceXGettingCollection<E>
-
count
- Specified by:
count
in interfaceXGettingCollection<E>
-
countBy
- Specified by:
countBy
in interfaceXGettingCollection<E>
-
distinct
- Specified by:
distinct
in interfaceXGettingCollection<E>
-
distinct
- Specified by:
distinct
in interfaceXGettingCollection<E>
-
equals
Deprecated.Description copied from interface:XGettingCollection
Performs an equality comparison according to the specification inCollection
.Note that it is this interface's author opinion that the whole concept of equals() in standard Java, especially in the collection implementations, is flawed.
The reason is because all different kinds of comparison types that actually depend on the situation have to be mixed up in a harcoded fashion in one method, from identity comparison over data indentity comparison to content comparison.
In order to get the right behavior in every situation, one has to distinct between different types of equality
This means several things:
1.) You can't just say for example an ArrayList is the "same" as a LinkedList just because they contain the same content.
There are different implementations for a good reason, so you have to distinct them when comparing. There are simple code examples which create massive misbehavior that will catastrophically ruin the runtime behavior of a programm due to this error in Java / JDK / Sun / whatever.
2.) You can't always determine equality of two collections by determining equality of each element asCollection
defines it.As a conclusion: don't use this method!
Be clear what type of comparison you really need, then use one of the following methods and proper comparators:
XGettingCollection.equals(XGettingCollection,Equalator)
XGettingCollection.equalsContent(XGettingCollection,Equalator)
- Specified by:
equals
in interfaceXGettingCollection<E>
- Overrides:
equals
in classObject
-
equals
public final boolean equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)Description copied from interface:XGettingCollection
Returnstrue
if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)
yieldstrue
.- Specified by:
equals
in interfaceXGettingCollection<E>
-
equalsContent
public final boolean equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)Description copied from interface:XGettingCollection
Returnstrue
if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.Note that for colletion types that don't have a defined order of elements, this method is hardly usable (as is
XGettingCollection.equals(Object)
for them as defined inCollection
). The core problem of comparing collections that have no defined order is that they aren't really reliably comparable to any other collection.- Specified by:
equalsContent
in interfaceXGettingCollection<E>
equalator
- the equalator to use to determine the equality of each element- Returns:
true
if 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:
except
in interfaceXGettingCollection<E>
-
iterate
-
iterateIndexed
- Specified by:
iterateIndexed
in interfaceXIndexIterable<E>
-
join
-
fill
- Specified by:
fill
in interfaceXSettingList<E>
-
at
- Specified by:
at
in interfaceXGettingSequence<E>
-
get
Description copied from interface:XGettingCollection
Gets one element from the collection. If the collection is not orderedXGettingSequence
, then it is undefined which element is returned. If the collection is ordered, the element at index 0 is returned.- Specified by:
get
in interfaceXGettingCollection<E>
- Specified by:
get
in interfaceXGettingSequence<E>
- Returns:
- the first / any element.
- See Also:
XGettingSequence.at(long)
,XGettingSequence.first()
,XGettingSequence.last()
-
first
- Specified by:
first
in interfaceXGettingSequence<E>
-
last
- Specified by:
last
in interfaceXGettingSequence<E>
-
poll
- Specified by:
poll
in interfaceXGettingSequence<E>
-
peek
- Specified by:
peek
in interfaceXGettingSequence<E>
-
hashCode
Deprecated.- Specified by:
hashCode
in interfaceXGettingCollection<E>
- Overrides:
hashCode
in classObject
-
indexBy
- Specified by:
indexBy
in interfaceXGettingSequence<E>
-
indexOf
- Specified by:
indexOf
in interfaceXGettingSequence<E>
-
intersect
public final <C extends Consumer<? super E>> C intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)- Specified by:
intersect
in interfaceXGettingCollection<E>
-
isEmpty
public final boolean isEmpty() -
isSorted
- Specified by:
isSorted
in interfaceXGettingSequence<E>
-
lastIndexBy
- Specified by:
lastIndexBy
in interfaceXGettingSequence<E>
-
lastIndexOf
- Specified by:
lastIndexOf
in interfaceXGettingSequence<E>
-
iterator
-
listIterator
- Specified by:
listIterator
in interfaceXGettingList<E>
-
listIterator
- Specified by:
listIterator
in interfaceXGettingList<E>
-
max
- Specified by:
max
in interfaceXGettingCollection<E>
-
maxIndex
- Specified by:
maxIndex
in interfaceXGettingSequence<E>
-
min
- Specified by:
min
in interfaceXGettingCollection<E>
-
minIndex
- Specified by:
minIndex
in interfaceXGettingSequence<E>
-
replace
- Specified by:
replace
in interfaceXReplacingBag<E>
-
replace
- Specified by:
replace
in interfaceXReplacingBag<E>
-
substitute
- Specified by:
substitute
in interfaceXReplacingCollection<E>
-
substitute
- Specified by:
substitute
in interfaceXReplacingBag<E>
-
replaceAll
- Specified by:
replaceAll
in interfaceXReplacingBag<E>
-
replaceOne
- Specified by:
replaceOne
in interfaceXReplacingBag<E>
-
replaceOne
- Specified by:
replaceOne
in interfaceXReplacingBag<E>
-
reverse
- Specified by:
reverse
in interfaceXOrderingSequence<E>
- Specified by:
reverse
in interfaceXSettingList<E>
- Specified by:
reverse
in interfaceXSettingSequence<E>
- Specified by:
reverse
in interfaceXSortableSequence<E>
-
scan
Description copied from interface:XGettingSequence
Iterates through the collection and returns the index of the last element that the passedPredicate
applied to ("scanning").- Specified by:
scan
in interfaceXGettingSequence<E>
- Returns:
- the index of the last positively tested 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>
-
search
- Specified by:
search
in interfaceXGettingCollection<E>
-
setAll
- Specified by:
setAll
in interfaceXSettingList<E>
- Specified by:
setAll
in interfaceXSettingSequence<E>
-
set
- Specified by:
set
in interfaceXSettingSequence<E>
-
setGet
- Specified by:
setGet
in interfaceXSettingSequence<E>
-
set
- Specified by:
set
in interfaceXSettingList<E>
- Specified by:
set
in interfaceXSettingSequence<E>
-
set
public final ListAccessor<E> set(long offset, XGettingSequence<? extends E> elements, long elementsOffset, long elementsLength)- Specified by:
set
in interfaceXSettingList<E>
- Specified by:
set
in interfaceXSettingSequence<E>
-
setFirst
- Specified by:
setFirst
in interfaceXSettingSequence<E>
-
setLast
- Specified by:
setLast
in interfaceXSettingSequence<E>
-
size
public final long size()- Specified by:
size
in interfaceSized
- Specified by:
size
in interfaceXGettingCollection<E>
-
maximumCapacity
public final long maximumCapacity()Description copied from interface:CapacityCarrying
Returns the maximum amount of elements this carrier instance can contain.
The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g.Integer.MAX_VALUE
)- Specified by:
maximumCapacity
in interfaceCapacityCarrying
- Returns:
- the maximum amount of elements this carrier instance can contain.
-
isFull
public final boolean isFull()Description copied from interface:CapacityCarrying
Returns true if the current capacity cannot be increased any more.- Specified by:
isFull
in interfaceCapacityCarrying
-
remainingCapacity
public final 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
-
sort
- Specified by:
sort
in interfaceSortable<E>
- Specified by:
sort
in interfaceXSettingList<E>
- Specified by:
sort
in interfaceXSettingSequence<E>
- Specified by:
sort
in interfaceXSortableSequence<E>
-
range
- Specified by:
range
in interfaceXGettingList<E>
- Specified by:
range
in interfaceXGettingSequence<E>
- Specified by:
range
in interfaceXSettingList<E>
- Specified by:
range
in interfaceXSettingSequence<E>
-
view
- Specified by:
view
in interfaceXGettingBag<E>
- Specified by:
view
in interfaceXGettingCollection<E>
- Specified by:
view
in interfaceXGettingList<E>
- Specified by:
view
in interfaceXGettingSequence<E>
-
view
- Specified by:
view
in interfaceXGettingList<E>
- Specified by:
view
in interfaceXGettingSequence<E>
-
shiftTo
- Specified by:
shiftTo
in interfaceXOrderingSequence<E>
- Specified by:
shiftTo
in interfaceXSortableSequence<E>
-
shiftTo
- Specified by:
shiftTo
in interfaceXOrderingSequence<E>
- Specified by:
shiftTo
in interfaceXSortableSequence<E>
-
shiftBy
- Specified by:
shiftBy
in interfaceXOrderingSequence<E>
- Specified by:
shiftBy
in interfaceXSortableSequence<E>
-
shiftBy
- Specified by:
shiftBy
in interfaceXOrderingSequence<E>
- Specified by:
shiftBy
in interfaceXSortableSequence<E>
-
swap
- Specified by:
swap
in interfaceXOrderingSequence<E>
- Specified by:
swap
in interfaceXSettingList<E>
- Specified by:
swap
in interfaceXSettingSequence<E>
- Specified by:
swap
in interfaceXSortableSequence<E>
-
swap
- Specified by:
swap
in interfaceXOrderingSequence<E>
- Specified by:
swap
in interfaceXSettingList<E>
- Specified by:
swap
in interfaceXSettingSequence<E>
- Specified by:
swap
in interfaceXSortableSequence<E>
-
toArray
- Specified by:
toArray
in interfaceXGettingCollection<E>
-
toArray
- Specified by:
toArray
in interfaceXGettingCollection<E>
-
toReversed
- Specified by:
toReversed
in interfaceXGettingList<E>
- Specified by:
toReversed
in interfaceXGettingSequence<E>
- Specified by:
toReversed
in interfaceXSettingList<E>
- Specified by:
toReversed
in interfaceXSettingSequence<E>
- Specified by:
toReversed
in interfaceXSortableSequence<E>
-
union
public final <C extends Consumer<? super E>> C union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)- Specified by:
union
in interfaceXGettingCollection<E>
-
copySelection
- Specified by:
copySelection
in interfaceXGettingSequence<E>
-
immure
Description copied from interface:XGettingCollection
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 interfaceXGettingList<E>
- Specified by:
immure
in interfaceXGettingSequence<E>
- Returns:
- an immutable copy of this collection instance.
-
old
- Specified by:
old
in interfaceXGettingCollection<E>
- Specified by:
old
in interfaceXGettingList<E>
-