Interface CCollection<E>
-
- All Superinterfaces:
CBaseState<java.lang.Iterable<E>>
,CBaseVerifier<java.lang.Iterable<E>>
,CBaseWaiter<java.lang.Iterable<E>>
,CCollectionState<E>
,CCollectionVerifier<E>
,CIterable<E>
,CIterableState<E>
,CIterableVerifier<E>
,CObjectState<java.lang.Iterable<E>>
,CObjectVerifier<java.lang.Iterable<E>,CIterableState<E>>
,java.util.Collection<E>
,java.lang.Iterable<E>
,java.io.Serializable
- All Known Implementing Classes:
CConfigInfoCollection
,CList
,CSet
public interface CCollection<E> extends CIterable<E>, java.util.Collection<E>, CCollectionVerifier<E>, CCollectionState<E>
This interfaceCCollection
uses to extendCollection
interface to facilitate testing and reduce coding. We hope to extend this class with more useful methods.- See Also:
Map
,CHashMap
,CLinkedMap
,CSet
,CList
-
-
Field Summary
-
Fields inherited from interface org.catools.common.extensions.states.interfaces.CBaseState
serialVersionUID
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description boolean
add(E e)
Ensures that this collection contains the specified element (optional operation).boolean
addAll(java.util.Collection<? extends E> c)
Adds all of the elements in the specified collection to this collection (optional operation).default boolean
addIf(java.util.function.Predicate<E> predicate, E e)
Adde
to the list if thepredicate
condition returns true.void
clear()
Removes all of the elements from this collection (optional operation).boolean
contains(java.lang.Object o)
Returnstrue
if this collection contains the specified element.boolean
containsAll(java.util.Collection<?> c)
Returnstrue
if this collection contains all of the elements in the specified collection.boolean
equals(java.lang.Object c)
Returnstrue
if this collection equals the specified collection.default E
getAnyAndRemove()
get a random value from the collection and remove it from the list.CCollection<E>
getBaseValue()
get theCollection
of itemsboolean
isEmpty()
Returnstrue
if this collection contains no elements.default CList<CList<E>>
partition(int size)
Returns consecutive sublists of a list, each of the same size (the final list may be smaller).boolean
remove(java.lang.Object o)
Removes CCliItemCollection single instance of the specified element from this collection, if it is present (optional operation).boolean
removeAll(java.util.Collection<?> c)
Removes all of this collection's elements that are also contained in the specified collection (optional operation).boolean
removeIf(java.util.function.Predicate<? super E> filter)
Removes all of the elements of this collection that satisfy the given predicate.boolean
retainAll(java.util.Collection<?> c)
Retains only the elements in this collection that are contained in the specified collection (optional operation).int
size()
Returns the number of elements in this collection.java.util.Spliterator<E>
spliterator()
Creates CCliItemCollectionSpliterator
over the elements in this collection.java.util.stream.Stream<E>
stream()
Returns CCliItemCollection sequentialStream
with this collection as its source.java.lang.Object[]
toArray()
Returns an array containing all of the elements in this collection.<E1> E1[]
toArray(E1[] a)
Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.default <K,V>
CMap<K,V>toMap(java.util.function.Function<? super E,? extends K> keyMapper, java.util.function.Function<? super E,? extends V> valueMapper)
ConvertCCollection
toCMap
and return the resultdefault <K,V>
CMap<K,V>toMap(java.util.function.Function<? super E,? extends K> keyMapper, java.util.function.Function<? super E,? extends V> valueMapper, java.util.function.BinaryOperator<V> mergeFunction)
ConvertCCollection
toCMap
and return the resultdefault <K,V,M extends java.util.Map<K,V>>
CMap<K,V>toMap(java.util.function.Function<? super E,? extends K> keyMapper, java.util.function.Function<? super E,? extends V> valueMapper, java.util.function.BinaryOperator<V> mergeFunction, java.util.function.Supplier<M> mapFactory)
ConvertCCollection
toCMap
and return the result-
Methods inherited from interface org.catools.common.extensions.verify.interfaces.CBaseVerifier
_useWaiter, _verify, _verify, _verify, _verify, _verify, _verify, _verify, _verify, _verify, getDefaultMessage, getDefaultMessage, getVerifyMessagePrefix
-
Methods inherited from interface org.catools.common.extensions.wait.interfaces.CBaseWaiter
getDefaultWaitInSeconds, getDefaultWaitIntervalInMilliSeconds
-
Methods inherited from interface org.catools.common.extensions.states.interfaces.CCollectionState
sizeEquals, sizeIsGreaterThan, sizeIsLessThan
-
Methods inherited from interface org.catools.common.extensions.verify.interfaces.CCollectionVerifier
_toState, verifySizeEquals, verifySizeEquals, verifySizeIsGreaterThan, verifySizeIsGreaterThan, verifySizeIsLessThan, verifySizeIsLessThan
-
Methods inherited from interface org.catools.common.collections.interfaces.CIterable
forEach, getAll, getAny, getFirst, getFirst, getFirstOrAny, getFirstOrElse, getFirstOrElse, getFirstOrElse, getFirstOrNull, getFirstOrNull, getFirstOrThrow, getFirstOrThrow, has, hasNot, iterator, join, join, join, map, mapToList, mapToSet, toList, toSet
-
Methods inherited from interface org.catools.common.extensions.states.interfaces.CIterableState
containsAll, containsNone, containsNone, emptyOrContains, emptyOrNotContains, isEqual, isEqual, isNotEmpty, notContains, notContainsAll, notContainsAll
-
Methods inherited from interface org.catools.common.extensions.verify.interfaces.CIterableVerifier
verifyContains, verifyContains, verifyContainsAll, verifyContainsAll, verifyContainsNone, verifyContainsNone, verifyEmptyOrContains, verifyEmptyOrContains, verifyEmptyOrNotContains, verifyEmptyOrNotContains, verifyEquals, verifyEquals, verifyHas, verifyHas, verifyIsEmpty, verifyIsEmpty, verifyIsNotEmpty, verifyIsNotEmpty, verifyNotContains, verifyNotContains, verifyNotContainsAll, verifyNotContainsAll
-
Methods inherited from interface org.catools.common.extensions.states.interfaces.CObjectState
equalsAny, equalsAny, equalsNone, equalsNone, isNotNull, isNull, notEqual, test
-
Methods inherited from interface org.catools.common.extensions.verify.interfaces.CObjectVerifier
verifyEqualsAny, verifyEqualsAny, verifyEqualsNone, verifyEqualsNone, verifyIsNotNull, verifyIsNotNull, verifyIsNull, verifyIsNull, verifyNotEquals, verifyNotEquals
-
-
-
-
Method Detail
-
add
boolean add(E e)
Ensures that this collection contains the specified element (optional operation). Returnstrue
if this collection changed as CCliItemCollection result of the get. (Returnsfalse
if this collection does not permit duplicates and already contains the specified element.)Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add
null
elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.If CCliItemCollection collection refuses to add CCliItemCollection particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning
false
). This preserves the invariant that CCliItemCollection collection always contains the specified element after this get returns.- Specified by:
add
in interfacejava.util.Collection<E>
- Parameters:
e
- element whose presence in this collection is to be ensured- Returns:
true
if this collection changed as CCliItemCollection result of the get- Throws:
java.lang.UnsupportedOperationException
- if theadd
operation is not supported by this collectionjava.lang.ClassCastException
- if the class of the specified element prevents it from being added to this collectionjava.lang.NullPointerException
- if the specified element is null and this collection does not permit null elementsjava.lang.IllegalArgumentException
- if some property of the element prevents it from being added to this collectionjava.lang.IllegalStateException
- if the element cannot be added at this time due to insertion restrictions
-
addAll
boolean addAll(java.util.Collection<? extends E> c)
Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this get is undefined if the specified collection is this collection, and this collection is nonempty.)- Specified by:
addAll
in interfacejava.util.Collection<E>
- Parameters:
c
- collection containing elements to be added to this collection- Returns:
true
if this collection changed as CCliItemCollection result of the get- Throws:
java.lang.UnsupportedOperationException
- if theaddAll
operation is not supported by this collectionjava.lang.ClassCastException
- if the class of an element of the specified collection prevents it from being added to this collectionjava.lang.NullPointerException
- if the specified collection contains CCliItemCollection null element and this collection does not permit null elements, or if the specified collection is nulljava.lang.IllegalArgumentException
- if some property of an element of the specified collection prevents it from being added to this collectionjava.lang.IllegalStateException
- if not all the elements can be added at this time due to insertion restrictions- See Also:
add(Object)
-
addIf
default boolean addIf(java.util.function.Predicate<E> predicate, E e)
Adde
to the list if thepredicate
condition returns true.- Parameters:
predicate
- to issue conditione
- element to add if condition passed- Returns:
- true if the condition matched otherwise return false
-
clear
void clear()
Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns.- Specified by:
clear
in interfacejava.util.Collection<E>
- Throws:
java.lang.UnsupportedOperationException
- if theclear
operation is not supported by this collection
-
contains
boolean contains(java.lang.Object o)
Returnstrue
if this collection contains the specified element. More formally, returnstrue
if and only if this collection contains at least one elemente
such thatObjects.equals(o, e)
.- Specified by:
contains
in interfaceCIterableState<E>
- Specified by:
contains
in interfacejava.util.Collection<E>
- Parameters:
o
- element whose presence in this collection is to be tested- Returns:
true
if this collection contains the specified element- Throws:
java.lang.ClassCastException
- if the type of the specified element is incompatible with this collectionjava.lang.NullPointerException
- if the specified element is null and this collection does not permit null elements
-
containsAll
boolean containsAll(java.util.Collection<?> c)
Returnstrue
if this collection contains all of the elements in the specified collection.- Specified by:
containsAll
in interfacejava.util.Collection<E>
- Parameters:
c
- collection to be checked for containment in this collection- Returns:
true
if this collection contains all of the elements in the specified collection- Throws:
java.lang.ClassCastException
- if the collections of one or more elements in the specified collection are incompatible with this collectionjava.lang.NullPointerException
- if the specified collection contains one or more null elements and this collection does not permit null elements , or if the specified collection is null.- See Also:
contains(Object)
-
equals
boolean equals(java.lang.Object c)
Returnstrue
if this collection equals the specified collection.- Specified by:
equals
in interfaceCIterable<E>
- Specified by:
equals
in interfacejava.util.Collection<E>
- Overrides:
equals
in classjava.lang.Object
- Parameters:
c
- collection to be checked for equality- Returns:
true
if this collection contains none of the elements in the specified collection- Throws:
java.lang.ClassCastException
- if the collections of one or more elements in the specified collection are incompatible with this collectionjava.lang.NullPointerException
- if the specified collection contains one or more null elements and this collection does not permit null elements , or if the specified collection is null.- See Also:
contains(Object)
-
getAnyAndRemove
default E getAnyAndRemove()
get a random value from the collection and remove it from the list.- Returns:
- random value or null if no value available
-
getBaseValue
CCollection<E> getBaseValue()
get theCollection
of items- Specified by:
getBaseValue
in interfaceCBaseState<E>
- Returns:
- the collection of items to be used in interface
-
isEmpty
boolean isEmpty()
Returnstrue
if this collection contains no elements.- Specified by:
isEmpty
in interfaceCIterableState<E>
- Specified by:
isEmpty
in interfacejava.util.Collection<E>
- Returns:
true
if this collection contains no elements
-
partition
default CList<CList<E>> partition(int size)
Returns consecutive sublists of a list, each of the same size (the final list may be smaller). For example, partitioning a list containing[a, b, c, d, e]
with a partition size of 3 yields[[a, b, c], [d, e]]
-- an outer list containing two inner lists of three and two elements, all in the original order.The outer list is unmodifiable, but reflects the latest state of the source list. The inner lists are sublist views of the original list, produced on demand using
List.subList(int, int)
, and are subject to all the usual caveats about modification as explained in that API.- Parameters:
size
- the desired size of each sublist (the last may be smaller)- Returns:
- a list of consecutive sublists
- Throws:
java.lang.IllegalArgumentException
- ifpartitionSize
is nonpositive
-
remove
boolean remove(java.lang.Object o)
Removes CCliItemCollection single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an elemente
such thatObjects.equals(o, e)
, if this collection contains one or more such elements. Returnstrue
if this collection contained the specified element (or equivalently, if this collection changed as CCliItemCollection result of the get).- Specified by:
remove
in interfacejava.util.Collection<E>
- Parameters:
o
- element to be removed from this collection, if present- Returns:
true
if an element was removed as CCliItemCollection result of this get- Throws:
java.lang.ClassCastException
- if the type of the specified element is incompatible with this collectionjava.lang.NullPointerException
- if the specified element is null and this collection does not permit null elementsjava.lang.UnsupportedOperationException
- if theremove
operation is not supported by this collection
-
removeAll
boolean removeAll(java.util.Collection<?> c)
Removes all of this collection's elements that are also contained in the specified collection (optional operation). After this get returns, this collection will contain no elements in common with the specified collection.- Specified by:
removeAll
in interfacejava.util.Collection<E>
- Parameters:
c
- collection containing elements to be removed from this collection- Returns:
true
if this collection changed as CCliItemCollection result of the get- Throws:
java.lang.UnsupportedOperationException
- if theremoveAll
method is not supported by this collectionjava.lang.ClassCastException
- if the collections of one or more elements in this collection are incompatible with the specified collectionjava.lang.NullPointerException
- if this collection contains one or more null elements and the specified collection does not support null elements , or if the specified collection is null- See Also:
remove(Object)
,contains(Object)
-
removeIf
boolean removeIf(java.util.function.Predicate<? super E> filter)
Removes all of the elements of this collection that satisfy the given predicate. Errors or runtime exceptions thrown during iteration or by the predicate are relayed to the caller.- Specified by:
removeIf
in interfacejava.util.Collection<E>
- Parameters:
filter
- CCliItemCollection predicate which returnstrue
for elements to be removed- Returns:
true
if any elements were removed- Throws:
java.lang.NullPointerException
- if the specified filter is nulljava.lang.UnsupportedOperationException
- if elements cannot be removed from this collection. Implementations may throw this exception if CCliItemCollection matching element cannot be removed or if, in general, removal is not supported.
-
retainAll
boolean retainAll(java.util.Collection<?> c)
Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.- Specified by:
retainAll
in interfacejava.util.Collection<E>
- Parameters:
c
- collection containing elements to be retained in this collection- Returns:
true
if this collection changed as CCliItemCollection result of the get- Throws:
java.lang.UnsupportedOperationException
- if theretainAll
operation is not supported by this collectionjava.lang.ClassCastException
- if the collections of one or more elements in this collection are incompatible with the specified collectionjava.lang.NullPointerException
- if this collection contains one or more null elements and the specified collection does not permit null elements , or if the specified collection is null- See Also:
remove(Object)
,contains(Object)
-
size
int size()
Returns the number of elements in this collection. If this collection contains more thanInteger.MAX_VALUE
elements, returnsInteger.MAX_VALUE
.- Specified by:
size
in interfacejava.util.Collection<E>
- Returns:
- the number of elements in this collection
-
spliterator
java.util.Spliterator<E> spliterator()
Creates CCliItemCollectionSpliterator
over the elements in this collection. Implementations should document characteristic values reported by the spliterator. Such characteristic values are not required to be reported if the spliterator reportsSpliterator.SIZED
and this collection contains no elements.- Specified by:
spliterator
in interfaceCIterable<E>
- Specified by:
spliterator
in interfacejava.util.Collection<E>
- Specified by:
spliterator
in interfacejava.lang.Iterable<E>
- Returns:
- CCliItemCollection
Spliterator
over the elements in this collection
-
stream
java.util.stream.Stream<E> stream()
Returns CCliItemCollection sequentialStream
with this collection as its source.This method should be overridden when the
spliterator()
method cannot return CCliItemCollection spliterator that isIMMUTABLE
,CONCURRENT
, or late-binding. (Seespliterator()
for details.)
-
toArray
java.lang.Object[] toArray()
Returns an array containing all of the elements in this collection. If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. The returned array's runtime component type isObject
.- Specified by:
toArray
in interfacejava.util.Collection<E>
- Returns:
- an array, whose runtime component
type is
Object
, containing all of the elements in this collection
-
toArray
<E1> E1[] toArray(E1[] a)
Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, CCliItemCollection new array is allocated with the runtime type of the specified array and the size of this collection.If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is set to
null
. (This is useful in determining the length of this collection only if the caller knows that this collection does not contain anynull
elements.)If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.
This method acts as CCliItemCollection bridge between array-based and collection-based APIs. It allows an existing array to be reused under certain circumstances. Use
toArray()
to create an array whose runtime type isObject[]
.Suppose
x
is CCliItemCollection collection known to contain only strings. The following code can be used to dump the collection into CCliItemCollection previously allocatedString
array:String[] y = new String[SIZE]; ... y = x.toArray(y);
The return value is reassigned to the variable
y
, because CCliItemCollection new array will be allocated and returned if the collectionx
has too many elements to fit into the existing arrayy
.Note that
toArray(new Object[0])
is identical in function totoArray()
.- Specified by:
toArray
in interfacejava.util.Collection<E>
- Type Parameters:
E1
- the component type of the array to contain the collection- Parameters:
a
- the array into which the elements of this collection are to be stored, if it is big enough; otherwise, CCliItemCollection new array of the same runtime type is allocated for this purpose.- Returns:
- an array containing all of the elements in this collection
- Throws:
java.lang.ArrayStoreException
- if the runtime type of any element in this collection is not assignable to the runtime component type of the specified arrayjava.lang.NullPointerException
- if the specified array is null
-
toMap
default <K,V> CMap<K,V> toMap(java.util.function.Function<? super E,? extends K> keyMapper, java.util.function.Function<? super E,? extends V> valueMapper)
ConvertCCollection
toCMap
and return the result- Returns:
- get
CMap
from elements ofCCollection
and return the result
-
toMap
default <K,V> CMap<K,V> toMap(java.util.function.Function<? super E,? extends K> keyMapper, java.util.function.Function<? super E,? extends V> valueMapper, java.util.function.BinaryOperator<V> mergeFunction)
ConvertCCollection
toCMap
and return the result- Returns:
- get
CMap
from elements ofCCollection
and return the result
-
toMap
default <K,V,M extends java.util.Map<K,V>> CMap<K,V> toMap(java.util.function.Function<? super E,? extends K> keyMapper, java.util.function.Function<? super E,? extends V> valueMapper, java.util.function.BinaryOperator<V> mergeFunction, java.util.function.Supplier<M> mapFactory)
ConvertCCollection
toCMap
and return the result- Returns:
- get
CMap
from elements ofCCollection
and return the result
-
-