Package org.catools.common.collections

Class CSet<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.HashSet<E>

org.catools.common.collections.CSet<E>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>, CCollection<E>, CIterable<E>, CBaseState<java.lang.Iterable<E>>, CCollectionState<E>, CIterableState<E>, CObjectState<java.lang.Iterable<E>>, CBaseVerifier<java.lang.Iterable<E>>, CCollectionVerifier<E>, CIterableVerifier<E>, CObjectVerifier<java.lang.Iterable<E>,CIterableState<E>>, CBaseWaiter<java.lang.Iterable<E>>

Direct Known Subclasses:

CConfigInfoCollection, CHolidayCollection

public class CSet<E>
extends java.util.HashSet<E>
implements CCollection<E>, java.util.Set<E>

See Also:

Serialized Form

Field Summary

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

serialVersionUID

Constructor Summary

Constructors

Constructor	Description
CSet()
CSet(E... c)
CSet(java.lang.Iterable<E> iterable)
CSet(java.util.stream.Stream<E> stream)

Method Summary

Modifier and Type	Method	Description
boolean	_useWaiter()
boolean	contains(java.lang.Object o)	Returns true if this collection contains the specified element.
boolean	equals(java.lang.Object c)	Returns true if this collection equals the specified collection.
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.
CCollection<E>	getBaseValue()	get the Collection of items
boolean	removeIf(java.util.function.Predicate<? super E> filter)	Removes all of the elements of this collection that satisfy the given predicate.
CSet<E>	set(java.util.Collection<? extends E> items)
java.util.stream.Stream<E>	stream()	Returns CCliItemCollection sequential Stream with this collection as its source.
java.lang.String	toString()

Methods inherited from class java.util.HashSet

add, clear, clone, isEmpty, iterator, remove, size, spliterator

Methods inherited from class java.util.AbstractSet

hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

_verify, _verify, _verify, _verify, _verify, _verify, _verifyWithDefaultMessage, _verifyWithDefaultMessage, getDefaultMessage, getEntityDescription

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

getDefaultWaitInSeconds, getDefaultWaitIntervalInMilliSeconds

Methods inherited from interface org.catools.common.collections.interfaces.CCollection

add, addAll, addIf, clear, containsAll, getAll, getAny, getAnyAndRemove, getFirst, getFirst, getFirstOrElse, getFirstOrElse, getFirstOrNull, getFirstOrNull, getFirstOrThrow, getFirstOrThrow, has, hasNot, isEmpty, isNotEmpty, iterator, join, join, join, map, mapToList, mapToSet, partition, remove, removeAll, retainAll, size, spliterator, toArray, toArray, toList, toSet

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.extensions.states.interfaces.CIterableState

containsAll, containsNone, containsNone, emptyOrContains, emptyOrNotContains, isEqual, isEqual, 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

Methods inherited from interface java.util.Collection

parallelStream, toArray

Methods inherited from interface java.util.Set

add, addAll, clear, containsAll, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

Constructor Detail

CSet

public CSet()

CSet

public CSet(E... c)

CSet

public CSet(java.util.stream.Stream<E> stream)

CSet

public CSet(java.lang.Iterable<E> iterable)

Method Detail

contains

public boolean contains(java.lang.Object o)

Description copied from interface: CCollection

Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that Objects.equals(o, e).

Specified by:

contains in interface CCollection<E>

Specified by:

contains in interface CIterableState<E>

Specified by:

contains in interface java.util.Collection<E>

Specified by:

contains in interface java.util.Set<E>

Overrides:

contains in class java.util.HashSet<E>

Parameters:

o - element whose presence in this collection is to be tested

Returns:

true if this collection contains the specified element

equals

public boolean equals(java.lang.Object c)

Description copied from interface: CCollection

Returns true if this collection equals the specified collection.

Specified by:

equals in interface CCollection<E>

Specified by:

equals in interface CIterable<E>

Specified by:

equals in interface java.util.Collection<E>

Specified by:

equals in interface java.util.Set<E>

Overrides:

equals in class java.util.AbstractSet<E>

Parameters:

c - collection to be checked for equality

Returns:

true if this collection contains none of the elements in the specified collection

See Also:

CCollection.contains(Object)

forEach

public void forEach(java.util.function.Consumer<? super E> action)

Description copied from interface: CCollection

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 CCollection<E>

Specified by:

forEach in interface CIterable<E>

Specified by:

forEach in interface java.lang.Iterable<E>

Parameters:

action - The action to be performed for each element

getBaseValue

public CCollection<E> getBaseValue()

get the Collection of items

Specified by:

getBaseValue in interface CBaseState<E>

Specified by:

getBaseValue in interface CCollection<E>

Returns:

the collection of items to be used in interface

removeIf

public boolean removeIf(java.util.function.Predicate<? super E> filter)

Description copied from interface: CCollection

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 interface CCollection<E>

Specified by:

removeIf in interface java.util.Collection<E>

Parameters:

filter - CCliItemCollection predicate which returns true for elements to be removed

Returns:

true if any elements were removed

set

public CSet<E> set(java.util.Collection<? extends E> items)

stream

public java.util.stream.Stream<E> stream()

Description copied from interface: CCollection

Returns CCliItemCollection sequential Stream with this collection as its source.

This method should be overridden when the CCollection.spliterator() method cannot return CCliItemCollection spliterator that is IMMUTABLE, CONCURRENT, or late-binding. (See CCollection.spliterator() for details.)

Specified by:

stream in interface CCollection<E>

Specified by:

stream in interface CIterable<E>

Specified by:

stream in interface java.util.Collection<E>

Returns:

CCliItemCollection sequential Stream over the elements in this collection

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractCollection<E>

_useWaiter

public boolean _useWaiter()

Specified by:

_useWaiter in interface CBaseVerifier<E>