All Superinterfaces:

CBaseState<java.lang.Iterable<E>>, CBaseVerifier<java.lang.Iterable<E>>, CBaseWaiter<java.lang.Iterable<E>>, CIterableExtension<E,java.lang.Iterable<E>>, CIterableState<E>, CIterableVerifier<E>, CIterableWaiter<E>, CObjectState<java.lang.Iterable<E>>, CObjectVerifier<java.lang.Iterable<E>>, CObjectWaiter<java.lang.Iterable<E>>, java.lang.Iterable<E>

All Known Subinterfaces:

CCollection<E>

All Known Implementing Classes:

CConfigInfoCollection, CHolidayCollection, CList, CSet, CTestResults
```
public interface CIterable<E>
extends java.lang.Iterable<E>, CIterableExtension<E,java.lang.Iterable<E>>
```
This interface CIterable uses to extend Collection interface to facilitate testing and reduce coding. We hope to extend this class with more useful methods.

See Also:

Map, CHashMap, CLinkedMap, CSet, CList

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object c)`	Returns `true` if this collection equals the specified collection.
`default void`	`forEach(java.util.function.Consumer<? super E> action)`	Performs the given action for each element of the `Iterable` until all elements have been processed or the action throws an exception.
`default CList<E>`	`getAll(java.util.function.Predicate<E> predicate)`	Returns CCliItemCollection sequance of values which matched the `predicate`.
`default E`	`getAny()`	get a random value from the collection.
`default E`	`getFirst()`	Returns a first element from list.
`default E`	`getFirst(java.util.function.Predicate<E> predicate)`	Returns a first element from list which matched the `predicate` otherwise throws `NoSuchElementException`.
`default E`	`getFirstOrElse(E other)`	Returns a first element from list if the list is not empty otherwise returns `other` value.
`default E`	`getFirstOrElse(java.util.function.Predicate<E> predicate, E other)`	Returns a first element from list which matched the `predicate` otherwise returns `other` value.
`default E`	`getFirstOrNull()`	Returns a first element from list if the list is not empty otherwise returns `null` value.
`default E`	`getFirstOrNull(java.util.function.Predicate<E> predicate)`	Returns CCliItemCollection first element from list which matched the `predicate` otherwise returns `null` value.
`default E`	`getFirstOrThrow(java.lang.RuntimeException e)`	Returns CCliItemCollection first element from list if the list is not empty otherwise throws `RuntimeException`.
`default E`	`getFirstOrThrow(java.util.function.Predicate<E> predicate, java.lang.RuntimeException e)`	Returns CCliItemCollection first element from list which matched the `predicate` otherwise throws `RuntimeException`.
`default boolean`	`has(java.util.function.Predicate<E> predicate)`	Indicate if `predicate` condition returns true for any record in the list The preferred alternative to this method is `getFirst()`, `getFirstOrElse(Object)`, `getFirstOrElse(Predicate, Object)`, `getFirstOrThrow(RuntimeException)`, `getFirstOrThrow(Predicate, RuntimeException)` `hasNot(Predicate)`
`default boolean`	`hasNot(java.util.function.Predicate<E> predicate)`	Indicate if `predicate` condition returns false for all records in the list The preferred alternative to this method is `getFirst()`, `getFirstOrElse(Object)`, `getFirstOrElse(Predicate, Object)`, `getFirstOrThrow(RuntimeException)`, `getFirstOrThrow(Predicate, RuntimeException)` `has(Predicate)`
`java.util.Iterator<E>`	`iterator()`	Returns an iterator over the elements in this collection.
`default java.lang.String`	`join()`	Joins the elements of `CCollection` into CCliItemCollection single String containing the provided elements.
`default java.lang.String`	`join(java.lang.String separator)`	Joins the elements of `CCollection` into CCliItemCollection single String containing the provided elements.
`default java.lang.String`	`join(java.util.function.Function<? super E,? extends java.lang.String> mapper, java.lang.String separator)`	Joins the elements of `CCollection` into CCliItemCollection single String containing the provided elements.
`default <R> java.util.stream.Stream<R>`	`map(java.util.function.Function<? super E,? extends R> mapper)`	Returns CCliItemCollection stream consisting of the results of applying the given function to the elements of this stream.
`default <R> CList<R>`	`mapToList(java.util.function.Function<? super E,? extends R> mapper)`	Returns CCliItemCollection `CList` consisting of the results of applying the given function to the elements of the `CCollection`.
`default <R> CSet<R>`	`mapToSet(java.util.function.Function<? super E,? extends R> mapper)`	Returns CCliItemCollection `CSet` consisting of the results of applying the given function to the elements of the `CCollection`.
`default java.util.Spliterator<E>`	`spliterator()`	Creates CCliItemCollection `Spliterator` over the elements in this collection.
`default java.util.stream.Stream<E>`	`stream()`	Returns CCliItemCollection sequential `Stream` with this collection as its source.
`default java.lang.Object[]`	`toArray()`	Returns an array containing all of the elements in this collection.
`default <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 CList<E>`	`toList()`	Convert `CCollection` to `CList` and return the result
`default CSet<E>`	`toSet()`	Convert `CCollection` to `CSet` and return the result

Methods inherited from interface org.catools.common.extensions.states.interfaces.CBaseState
getValue

Methods inherited from interface org.catools.common.extensions.verify.interfaces.CBaseVerifier
_verify, _verify, _verify

Methods inherited from interface org.catools.common.extensions.wait.interfaces.CBaseWaiter
getDefaultWaitInSeconds, getDefaultWaitIntervalInMilliSeconds

Methods inherited from interface org.catools.common.extensions.states.interfaces.CIterableState
contains, containsAll, containsNone, containsNone, emptyOrContains, emptyOrNotContains, equals, equals, isEmpty, isNotEmpty, notContains, notContainsAll, notContainsAll

Methods inherited from interface org.catools.common.extensions.verify.interfaces.CIterableVerifier
verifyContains, verifyContains, verifyContains, verifyContains, verifyContains, verifyContains, verifyContainsAll, verifyContainsAll, verifyContainsAll, verifyContainsAll, verifyContainsAll, verifyContainsAll, verifyContainsNone, verifyContainsNone, verifyContainsNone, verifyContainsNone, verifyContainsNone, verifyContainsNone, verifyEmptyOrContains, verifyEmptyOrContains, verifyEmptyOrContains, verifyEmptyOrContains, verifyEmptyOrContains, verifyEmptyOrContains, verifyEmptyOrNotContains, verifyEmptyOrNotContains, verifyEmptyOrNotContains, verifyEmptyOrNotContains, verifyEmptyOrNotContains, verifyEmptyOrNotContains, verifyEquals, verifyEquals, verifyEquals, verifyEquals, verifyEquals, verifyEquals, verifyIsEmpty, verifyIsEmpty, verifyIsEmpty, verifyIsEmpty, verifyIsEmpty, verifyIsEmpty, verifyIsNotEmpty, verifyIsNotEmpty, verifyIsNotEmpty, verifyIsNotEmpty, verifyIsNotEmpty, verifyIsNotEmpty, verifyNotContains, verifyNotContains, verifyNotContains, verifyNotContains, verifyNotContains, verifyNotContains, verifyNotContainsAll, verifyNotContainsAll, verifyNotContainsAll, verifyNotContainsAll, verifyNotContainsAll, verifyNotContainsAll

Methods inherited from interface org.catools.common.extensions.wait.interfaces.CIterableWaiter
waitContains, waitContains, waitContains, waitContainsAll, waitContainsAll, waitContainsAll, waitContainsNone, waitContainsNone, waitContainsNone, waitEmptyOrContains, waitEmptyOrContains, waitEmptyOrContains, waitEmptyOrNotContains, waitEmptyOrNotContains, waitEmptyOrNotContains, waitEquals, waitEquals, waitEquals, waitIsEmpty, waitIsEmpty, waitIsEmpty, waitIsNotEmpty, waitIsNotEmpty, waitIsNotEmpty, waitNotContains, waitNotContains, waitNotContains, waitNotContainsAll, waitNotContainsAll, waitNotContainsAll

Methods inherited from interface org.catools.common.extensions.states.interfaces.CObjectState
is

Methods inherited from interface org.catools.common.extensions.verify.interfaces.CObjectVerifier
verifyEqualsAny, verifyEqualsAny, verifyEqualsAny, verifyEqualsAny, verifyEqualsAny, verifyEqualsAny, verifyEqualsNone, verifyEqualsNone, verifyEqualsNone, verifyEqualsNone, verifyEqualsNone, verifyEqualsNone, verifyIsNotNull, verifyIsNotNull, verifyIsNotNull, verifyIsNotNull, verifyIsNotNull, verifyIsNotNull, verifyIsNull, verifyIsNull, verifyIsNull, verifyIsNull, verifyIsNull, verifyIsNull, verifyNotEquals, verifyNotEquals, verifyNotEquals, verifyNotEquals, verifyNotEquals, verifyNotEquals

Methods inherited from interface org.catools.common.extensions.wait.interfaces.CObjectWaiter
_waiter, wait, wait, wait, waitIsNotNull, waitIsNotNull, waitIsNotNull, waitObjectsEquals, waitObjectsEquals, waitObjectsEquals, waitObjectsNotEquals, waitObjectsNotEquals, waitObjectsNotEquals

- Method Detail
  - equals
```
boolean equals(java.lang.Object c)
```
    Returns true if this collection equals the specified collection.
    
    Overrides:
    
    equals in class java.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 collection
    
    java.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:
    
    CIterableState.contains(Object)
  - forEach
```
default void forEach(java.util.function.Consumer<? super E> action)
```
    Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller.
    The behavior of this method is unspecified if the action performs side-effects that modify the underlying source of elements, unless an overriding class has specified CCliItemCollection concurrent modification policy.
    Specified by:
    
    forEach in interface java.lang.Iterable<E>
    
    Parameters:
    
    action - The action to be performed for each element
    
    Throws:
    
    java.lang.NullPointerException - if the specified action is null
    for (T t : this) action.accept(t);
  - getAll
```
default CList<E> getAll(java.util.function.Predicate<E> predicate)
```
    Returns CCliItemCollection sequance of values which matched the predicate.
    
    Parameters:
    
    predicate - to issue condition
    
    Returns:
    
    the non-null collection of value described by this Optional
  - getAny
```
default E getAny()
```
    get a random value from the collection.
    
    Returns:
    
    random value or null if no value available
  - getFirst
```
default E getFirst()
```
    Returns a first element from list.
    
    Returns:
    
    Returns a first element from list.
  - getFirst
```
default E getFirst(java.util.function.Predicate<E> predicate)
```
    Returns a first element from list which matched the predicate otherwise throws NoSuchElementException. The preferred alternative to this method is getFirstOrElse(Object), getFirstOrElse(Predicate, Object), getFirstOrThrow(RuntimeException), getFirstOrThrow(Predicate, RuntimeException).
    
    Parameters:
    
    predicate - to issue condition
    
    Returns:
    
    the non-null value described by this Optional
    
    Throws:
    
    java.util.NoSuchElementException - if no value is present
  - getFirstOrElse
```
default E getFirstOrElse(E other)
```
    Returns a first element from list if the list is not empty otherwise returns other value. The preferred alternative to this method is getFirstOrElse(Object), getFirstOrElse(Predicate, Object), getFirstOrThrow(RuntimeException), getFirstOrThrow(Predicate, RuntimeException).
    
    Parameters:
    
    other - value to be return if not record found
    
    Returns:
    
    the non-null value described by this Optional
  - getFirstOrElse
```
default E getFirstOrElse(java.util.function.Predicate<E> predicate,
                         E other)
```
    Returns a first element from list which matched the predicate otherwise returns other value. The preferred alternative to this method is getFirst(), getFirstOrElse(Object), getFirstOrThrow(RuntimeException), getFirstOrThrow(Predicate, RuntimeException).
    
    Parameters:
    
    predicate - to issue condition
    
    other - value to be turn if no matched found
    
    Returns:
    
    the non-null value described by this Optional
  - getFirstOrNull
```
default E getFirstOrNull()
```
    Returns a first element from list if the list is not empty otherwise returns null value. The preferred alternative to this method is getFirstOrElse(Object), getFirstOrElse(Predicate, Object), getFirstOrThrow(RuntimeException), getFirstOrThrow(Predicate, RuntimeException).
    
    Returns:
    
    the non-null value described by this Optional
  - getFirstOrNull
```
default E getFirstOrNull(java.util.function.Predicate<E> predicate)
```
    Returns CCliItemCollection first element from list which matched the predicate otherwise returns null value. The preferred alternative to this method is getFirst(), getFirstOrElse(Object), getFirstOrThrow(RuntimeException), getFirstOrThrow(Predicate, RuntimeException).
    
    Parameters:
    
    predicate - to issue condition
    
    Returns:
    
    the non-null value described by this Optional
  - getFirstOrThrow
```
default E getFirstOrThrow(java.lang.RuntimeException e)
```
    Returns CCliItemCollection first element from list if the list is not empty otherwise throws RuntimeException. The preferred alternative to this method is getFirst(), getFirstOrElse(Object), getFirstOrElse(Predicate, Object), getFirstOrThrow(Predicate, RuntimeException).
    
    Parameters:
    
    e - exception to be throws if no record found
    
    Returns:
    
    the non-null value described by this Optional
    
    Throws:
    
    java.lang.RuntimeException - if no value is present
  - getFirstOrThrow
```
default E getFirstOrThrow(java.util.function.Predicate<E> predicate,
                          java.lang.RuntimeException e)
```
    Returns CCliItemCollection first element from list which matched the predicate otherwise throws RuntimeException. The preferred alternative to this method is getFirst(), getFirstOrElse(Object), getFirstOrElse(Predicate, Object), getFirstOrThrow(RuntimeException),
    
    Parameters:
    
    predicate - to issue condition
    
    e - the exception to be throws if no value found
    
    Returns:
    
    the non-null value described by this Optional
    
    Throws:
    
    java.lang.RuntimeException - if no value is present
  - has
```
default boolean has(java.util.function.Predicate<E> predicate)
```
    Indicate if predicate condition returns true for any record in the list The preferred alternative to this method is getFirst(), getFirstOrElse(Object), getFirstOrElse(Predicate, Object), getFirstOrThrow(RuntimeException), getFirstOrThrow(Predicate, RuntimeException) hasNot(Predicate)
    
    Parameters:
    
    predicate - to issue condition
    
    Returns:
    
    true if predicate condition returns true for any record in the list otherwise return false
  - hasNot
```
default boolean hasNot(java.util.function.Predicate<E> predicate)
```
    Indicate if predicate condition returns false for all records in the list The preferred alternative to this method is getFirst(), getFirstOrElse(Object), getFirstOrElse(Predicate, Object), getFirstOrThrow(RuntimeException), getFirstOrThrow(Predicate, RuntimeException) has(Predicate)
    
    Parameters:
    
    predicate - to issue condition
    
    Returns:
    
    true if predicate condition returns false for all records in the list otherwise return false
  - iterator
```
java.util.Iterator<E> iterator()
```
    Returns an iterator over the elements in this collection. There are no guarantees concerning the order in which the elements are returned (unless this collection is an instance of some class that provides CCliItemCollection guarantee).
    
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
    
    Returns:
    
    an Iterator over the elements in this collection
  - join
```
default java.lang.String join()
```
    Joins the elements of CCollection into CCliItemCollection single String containing the provided elements.
    
    No delimiter is added before or after the list.
    See the examples here: join(String).
    
    Returns:
    
    the joined String with no separator
  - join
```
default java.lang.String join(java.lang.String separator)
```
    Joins the elements of CCollection into CCliItemCollection single String containing the provided elements.
    
    No delimiter is added before or after the list. A null separator is the same as an empty String (CStringUtil.EMPTY).
    
    See the examples here: join(String).
    
    Parameters:
    
    separator - the separator character to use, null treated as CStringUtil.EMPTY
    
    Returns:
    
    the joined String separated by separator
  - join
```
default java.lang.String join(java.util.function.Function<? super E,? extends java.lang.String> mapper,
                              java.lang.String separator)
```
    Joins the elements of CCollection into CCliItemCollection single String containing the provided elements.
    
    No delimiter is added before or after the list. A null separator is the same as an empty String (CStringUtil.EMPTY).
    
    See the examples here: join(String).
    
    Parameters:
    
    mapper - the mapper to use, null treated as CStringUtil.EMPTY
    
    separator - the separator character to use, null treated as CStringUtil.EMPTY
    
    Returns:
    
    the joined String separated by separator
  - map
```
default <R> java.util.stream.Stream<R> map(java.util.function.Function<? super E,? extends R> mapper)
```
    Returns CCliItemCollection stream consisting of the results of applying the given function to the elements of this stream.
    
    Type Parameters:
    
    R - The element type of the new stream
    
    Parameters:
    
    mapper - function to apply to each element
    
    Returns:
    
    the new stream
  - mapToList
```
default <R> CList<R> mapToList(java.util.function.Function<? super E,? extends R> mapper)
```
    Returns CCliItemCollection CList consisting of the results of applying the given function to the elements of the CCollection.
    
    Type Parameters:
    
    R - The element type of the new CList
    
    Parameters:
    
    mapper - function to apply to each element
    
    Returns:
    
    the new CList
  - mapToSet
```
default <R> CSet<R> mapToSet(java.util.function.Function<? super E,? extends R> mapper)
```
    Returns CCliItemCollection CSet consisting of the results of applying the given function to the elements of the CCollection.
    
    Type Parameters:
    
    R - The element type of the new CSet
    
    Parameters:
    
    mapper - function to apply to each element
    
    Returns:
    
    the new CSet
  - spliterator
```
default java.util.Spliterator<E> spliterator()
```
    Creates CCliItemCollection Spliterator 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 reports Spliterator.SIZED and this collection contains no elements.
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<E>
    
    Returns:
    
    CCliItemCollection Spliterator over the elements in this collection
  - stream
```
default java.util.stream.Stream<E> stream()
```
    Returns CCliItemCollection sequential Stream with this collection as its source.
    This method should be overridden when the spliterator() method cannot return CCliItemCollection spliterator that is IMMUTABLE, CONCURRENT, or late-binding. (See spliterator() for details.)
    
    Returns:
    
    CCliItemCollection sequential Stream over the elements in this collection
  - toArray
```
default 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 is Object.
    
    Returns:
    
    an array, whose runtime component type is Object, containing all of the elements in this collection
  - toArray
```
default <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 any null 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.
    
    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 array
    
    java.lang.NullPointerException - if the specified array is null
  - toList
```
default CList<E> toList()
```
    Convert CCollection to CList and return the result
    
    Returns:
    
    get CList from elements of CCollection and return the result
  - toSet
```
default CSet<E> toSet()
```
    Convert CCollection to CSet and return the result
    
    Returns:
    
    get CSet from elements of CCollection and return the result

Interface CIterable<E>

Method Summary

Methods inherited from interface org.catools.common.extensions.states.interfaces.CBaseState

Methods inherited from interface org.catools.common.extensions.verify.interfaces.CBaseVerifier

Methods inherited from interface org.catools.common.extensions.wait.interfaces.CBaseWaiter

Methods inherited from interface org.catools.common.extensions.states.interfaces.CIterableState

Methods inherited from interface org.catools.common.extensions.verify.interfaces.CIterableVerifier

Methods inherited from interface org.catools.common.extensions.wait.interfaces.CIterableWaiter

Methods inherited from interface org.catools.common.extensions.states.interfaces.CObjectState

Methods inherited from interface org.catools.common.extensions.verify.interfaces.CObjectVerifier

Methods inherited from interface org.catools.common.extensions.wait.interfaces.CObjectWaiter

Method Detail

equals

forEach

getAll

getAny

getFirst

getFirst

getFirstOrElse

getFirstOrElse

getFirstOrNull

getFirstOrNull

getFirstOrThrow

getFirstOrThrow

has

hasNot

iterator

join

join

join

map

mapToList

mapToSet

spliterator

stream

toArray

toArray

toList

toSet