Interface XGettingCollection<E>
- Type Parameters:
E
- type of contained elements
- All Superinterfaces:
CapacityCarrying
,Copyable
,ExtendedCollection<E>
,Iterable<E>
,Sized
,XIterable<E>
,XJoinable<E>
- All Known Subinterfaces:
XAddGetCollection<E>
,XAddGetMap<K,V>
,XAddGetSet<E>
,XBag<E>
,XBasicEnum<E>
,XBasicList<E>
,XBasicSequence<E>
,XBasicTable<K,V>
,XBasicTable.Keys<K,V>
,XBasicTable.Values<K,V>
,XChart<K,V>
,XChart.Keys<K,V>
,XChart.Values<K,V>
,XCollection<E>
,XDecreasingEnum<E>
,XDecreasingList<E>
,XDecreasingSequence<E>
,XEnum<E>
,XGettingBag<E>
,XGettingEnum<E>
,XGettingList<E>
,XGettingMap<K,V>
,XGettingMap.Keys<K,V>
,XGettingMap.Values<K,V>
,XGettingSequence<E>
,XGettingSet<E>
,XGettingSortation<E>
,XGettingTable<K,V>
,XGettingTable.Keys<K,V>
,XGettingTable.Values<K,V>
,XImmutableBag<E>
,XImmutableCollection<E>
,XImmutableEnum<E>
,XImmutableEnum.Factory<E>
,XImmutableList<E>
,XImmutableMap<K,V>
,XImmutableMap.Keys<K,V>
,XImmutableMap.Values<K,V>
,XImmutableSequence<E>
,XImmutableSet<E>
,XImmutableTable<K,V>
,XImmutableTable.Keys<K,V>
,XImmutableTable.Values<K,V>
,XIncreasingEnum<E>
,XIncreasingList<E>
,XIncreasingSequence<E>
,XLadder<E>
,XList<E>
,XMap<K,V>
,XMap.Keys<K,V>
,XMap.Values<K,V>
,XProcessingBag<E>
,XProcessingCollection<E>
,XProcessingEnum<E>
,XProcessingList<E>
,XProcessingMap<K,V>
,XProcessingMap.Keys<K,V>
,XProcessingMap.Values<K,V>
,XProcessingSequence<E>
,XProcessingSet<E>
,XProcessingSortation<E>
,XPutGetBag<E>
,XPutGetCollection<E>
,XPutGetEnum<E>
,XPutGetList<E>
,XPutGetMap<K,V>
,XPutGetSequence<E>
,XPutGetSet<E>
,XPutGetSortation<E>
,XRank<E>
,XReference<E>
,XReferencing<E>
,XReplacingBag<E>
,XSequence<E>
,XSet<E>
,XSettingEnum<E>
,XSettingList<E>
,XSettingSequence<E>
,XSortableEnum<E>
,XSortableSequence<E>
,XSortation<E>
,XTable<K,V>
,XTable.Keys<K,V>
,XTable.Values<K,V>
- All Known Implementing Classes:
ArrayAccessor
,ArrayCollector
,ArrayView
,BulkList
,Constant
,ConstHashEnum
,ConstHashTable
,ConstHashTable.Keys
,ConstHashTable.Values
,ConstLinearEnum
,ConstList
,Empty
,EmptyTable
,EnumProcessor
,EnumView
,EqBulkList
,EqConstHashEnum
,EqConstHashTable
,EqConstHashTable.Keys
,EqConstHashTable.Values
,EqConstList
,EqHashEnum
,EqHashTable
,EqHashTable.Keys
,EqHashTable.Values
,FixedList
,HashEnum
,HashTable
,HashTable.Keys
,HashTable.Values
,LimitList
,LinkingReferencing.Default
,LinkReference.Default
,ListAccessor
,ListProcessor
,ListView
,LockedCollection
,LockedGettingMap
,LockedList
,LockedMap
,MappedList
,MapView
,MutexSet
,OpenAdressingMiniSet
,SetView
,Single
,Singleton
,SingletonView
,SubCollector
,SubList
,SubListAccessor
,SubListProcessor
,SubListView
,SubProcessor
,SubView
,SynchCollection
,SynchList
,SynchSet
,TableView
,View
public interface XGettingCollection<E> extends XIterable<E>, XJoinable<E>, ExtendedCollection<E>, Iterable<E>, CapacityCarrying, Copyable
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
XGettingCollection.Creator<E>
Nested classes/interfaces inherited from interface one.microstream.collections.types.XIterable
XIterable.Executor<E>
-
Method Summary
Modifier and Type Method Description boolean
applies(Predicate<? super E> predicate)
Tests each element of the collection on the given predicate.boolean
contains(E element)
Checks if the given element is contained in the collection.default 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 ascontainsSearched(Predicate)
with aPredicate
implementation that checks for object identity.boolean
containsSearched(Predicate<? super E> predicate)
XGettingCollection<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.<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(Object o)
Deprecated.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).<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
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.XImmutableCollection<E>
immure()
Provides an instance of an immutable collection type with equal behavior and data as this instance.<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.default int
intSize()
Iterator<E>
iterator()
default <A> A
join(BiConsumer<? super E,? super A> joiner, A aggregate)
Iterates over all elements of the collections and calls the joiner with each element and the aggregate.E
max(Comparator<? super E> comparator)
E
min(Comparator<? super E> comparator)
boolean
nullContained()
OldCollection<E>
old()
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.long
size()
default Object[]
toArray()
Returns an array containing all of the elements in this collection.default E[]
toArray(Class<E> type)
Returns a typed array containing all of the elements in this collection.<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.XGettingCollection<E>
view()
Creates a view of this collection and returns it.Methods inherited from interface one.microstream.collections.interfaces.CapacityCarrying
isFull, maximumCapacity, remainingCapacity
Methods inherited from interface one.microstream.collections.interfaces.ExtendedCollection
nullAllowed
-
Method Details
-
get
E get()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.- Returns:
- the first / any element.
-
iterator
-
toArray
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.
- Returns:
- an array containing all of the elements in this collection
-
toArray
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.
- Returns:
- a typed array containing all of the elements in this collection
-
old
OldCollection<E> old() -
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>
- Returns:
true
if the collection contains volatile elements.
-
size
long size() -
intSize
default int intSize() -
equality
-
equals
- Parameters:
equalator
- is used to check the equality of the collectionssamples
- is the collection which is checked for equality- Returns:
true
if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)
yieldstrue
-
equalsContent
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
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.- Parameters:
equalator
- the equalator to use to determine the equality of each elementsamples
- is the collection which is checked for equality- Returns:
true
if this list is equal to the passed list,false
otherwise
-
immure
XImmutableCollection<E> immure()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.
- Returns:
- an immutable copy of this collection instance.
-
view
XGettingCollection<E> view()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 (
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.- Returns:
- new read-only collection to view this collection
-
copy
XGettingCollection<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. The elements themselves are NOT copied (no deep copying).
The type of the returned set is the same as of this list if possible. -
nullContained
boolean nullContained() -
containsId
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 ascontainsSearched(Predicate)
with aPredicate
implementation that checks for object identity. The only difference is a performance and usability advantage- Parameters:
element
- the element to be searched in the collection by identity.- Returns:
- whether this collection contains exactly the given element.
-
contains
Checks if the given element is contained in the collection.
In contrast to thecontainsId(Object)
method, this method uses the internalEqualator
defined by the collection itself.- Parameters:
element
- to be searched in the collection- Returns:
- Whether this collection contains the given element as specified by the
Equalator
.
-
containsSearched
-
containsAll
- Parameters:
elements
- to be searched in the collection.- Returns:
- Whether this collection contains all given elements as specified by the
Equalator
.
-
applies
Tests each element of the collection on the given predicate.- 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
Count how many times this element matches another element in the collection using theEqualator
.- Parameters:
element
- to count- Returns:
- Amount of matches
-
countBy
Count how many matches are found using the given predicate on each element of the collection.- Parameters:
predicate
- defines which elements are counted and which are not- Returns:
- Amount of matches
-
search
Returns the first contained element matching the passed predicate.- Parameters:
predicate
- defines which element is searched- Returns:
- Matching element
-
seek
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 ofcontains(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)- Parameters:
sample
- to seek in the collection- Returns:
- the first contained element matching the passed sample
-
max
-
min
-
distinct
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.- Parameters:
target
- on which theConsumer.accept(Object)
is called for every distinct element of this collection.- Returns:
- Given target
-
distinct
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.- 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
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.- Parameters:
target
- on which theConsumer.accept(Object)
is called for all elements of this collection.- Returns:
- Given target
-
filterTo
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.- 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)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.- 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)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.- 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)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.- 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
-
join
Description copied from interface:XJoinable
Iterates over all elements of the collections and calls the joiner with each element and the aggregate. -
equals
Deprecated.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:
equals(XGettingCollection, Equalator)
equalsContent(XGettingCollection, Equalator)
-
hashCode
Deprecated.
-