com.helger.commons.collection.ext

Interface ICommonsCollection<ELEMENTTYPE>

All Superinterfaces:

Collection<ELEMENTTYPE>, Iterable<ELEMENTTYPE>, Serializable

All Known Subinterfaces:

ICommonsList<ELEMENTTYPE>, ICommonsNavigableSet<ELEMENTTYPE>, ICommonsOrderedSet<ELEMENTTYPE>, ICommonsSet<ELEMENTTYPE>, ICommonsSortedSet<ELEMENTTYPE>

All Known Implementing Classes:

CommonsArrayList, CommonsCopyOnWriteArrayList, CommonsCopyOnWriteArraySet, CommonsHashSet, CommonsLinkedHashSet, CommonsLinkedList, CommonsTreeSet, CommonsVector, KeyValuePairList, NonBlockingStack, SafeArrayList, SafeVector, SingleElementList, WrappedCollection, WrappedList, WrappedSet

public interface ICommonsCollection<ELEMENTTYPE>
extends Collection<ELEMENTTYPE>, Serializable

Method Summary

Modifier and Type	Method and Description
default void	addAll(ELEMENTTYPE... aValues) Add an array of elements
default void	addAll(Enumeration<? extends ELEMENTTYPE> aEnum)
default void	addAll(Iterable<? extends ELEMENTTYPE> aIterable)
default void	addAll(Iterator<? extends ELEMENTTYPE> aIter)
default <SRCTYPE> void	addAllMapped(Iterable<? extends SRCTYPE> aValues, Function<? super SRCTYPE,? extends ELEMENTTYPE> aMapper)
default <SRCTYPE> void	addAllMapped(SRCTYPE[] aValues, Function<? super SRCTYPE,? extends ELEMENTTYPE> aMapper)
default void	addIf(ELEMENTTYPE aValue, Predicate<ELEMENTTYPE> aFilter)
default void	addIfNotNull(ELEMENTTYPE aValue)
default boolean	containsAny(Predicate<? super ELEMENTTYPE> aFilter)
default boolean	containsNone(Predicate<? super ELEMENTTYPE> aFilter)
default boolean	containsOnly(Predicate<? super ELEMENTTYPE> aFilter)
default void	findAll(Predicate<? super ELEMENTTYPE> aFilter, Collection<? super ELEMENTTYPE> aDst)
default void	findAll(Predicate<? super ELEMENTTYPE> aFilter, Consumer<? super ELEMENTTYPE> aConsumer)
default <DSTTYPE extends ELEMENTTYPE> void	findAllInstanceOf(Class<DSTTYPE> aDstClass, Consumer<? super DSTTYPE> aConsumer)
default <DSTTYPE> void	findAllMapped(Function<? super ELEMENTTYPE,DSTTYPE> aMapper, Collection<? super DSTTYPE> aDst)
default <DSTTYPE> void	findAllMapped(Function<? super ELEMENTTYPE,DSTTYPE> aMapper, Consumer<? super DSTTYPE> aConsumer)
default <DSTTYPE> void	findAllMapped(Predicate<? super ELEMENTTYPE> aFilter, Function<? super ELEMENTTYPE,DSTTYPE> aMapper, Collection<? super DSTTYPE> aDst)
default <DSTTYPE> void	findAllMapped(Predicate<? super ELEMENTTYPE> aFilter, Function<? super ELEMENTTYPE,DSTTYPE> aMapper, Consumer<? super DSTTYPE> aConsumer)
default ELEMENTTYPE	findFirst(Predicate<? super ELEMENTTYPE> aFilter)
default ELEMENTTYPE	findFirst(Predicate<? super ELEMENTTYPE> aFilter, ELEMENTTYPE aDefault)
default <DSTTYPE> DSTTYPE	findFirstMapped(Predicate<? super ELEMENTTYPE> aFilter, Function<? super ELEMENTTYPE,DSTTYPE> aMapper)
default <DSTTYPE> DSTTYPE	findFirstMapped(Predicate<? super ELEMENTTYPE> aFilter, Function<? super ELEMENTTYPE,DSTTYPE> aMapper, DSTTYPE aDefault)
default Collection<ELEMENTTYPE>	getAsUnmodifiable()
default ELEMENTTYPE	getAtIndex(int nIndex) Safe collection element accessor method.
default ELEMENTTYPE	getAtIndex(int nIndex, ELEMENTTYPE aDefault) Safe collection element accessor method.
default ELEMENTTYPE	getAtIndex(Predicate<? super ELEMENTTYPE> aFilter, int nIndex)
default ELEMENTTYPE	getAtIndex(Predicate<? super ELEMENTTYPE> aFilter, int nIndex, ELEMENTTYPE aDefault)
default <DSTTYPE> DSTTYPE	getAtIndexMapped(Predicate<? super ELEMENTTYPE> aFilter, int nIndex, Function<? super ELEMENTTYPE,? extends DSTTYPE> aMapper)
default <DSTTYPE> DSTTYPE	getAtIndexMapped(Predicate<? super ELEMENTTYPE> aFilter, int nIndex, Function<? super ELEMENTTYPE,? extends DSTTYPE> aMapper, DSTTYPE aDefault)
default ICommonsList<ELEMENTTYPE>	getCopyAsList()
default int	getCount(Predicate<? super ELEMENTTYPE> aFilter)
default ICommonsList<ELEMENTTYPE>	getSorted(Comparator<? super ELEMENTTYPE> aComparator)
default boolean	isNotEmpty()
default IIterableIterator<ELEMENTTYPE>	iterator2()
default EChange	removeAll()
default void	set(ELEMENTTYPE aValue) Clear and add the passed value
default void	setAll(Collection<? extends ELEMENTTYPE> aValues) Clear and add all provided values.
default void	setAll(ELEMENTTYPE... aValues) Clear and add all provided values.

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

isNotEmpty

default boolean isNotEmpty()

Returns:

true if the map is not empty, false otherwise.

getCopyAsList

@Nonnull
 @ReturnsMutableCopy
default ICommonsList<ELEMENTTYPE> getCopyAsList()

findAll

default void findAll(@Nullable
                     Predicate<? super ELEMENTTYPE> aFilter,
                     @Nonnull
                     Collection<? super ELEMENTTYPE> aDst)

findAll

default void findAll(@Nullable
                     Predicate<? super ELEMENTTYPE> aFilter,
                     @Nonnull
                     Consumer<? super ELEMENTTYPE> aConsumer)

findAllMapped

@Nonnull
 @ReturnsMutableCopy
default <DSTTYPE> void findAllMapped(@Nonnull
                                                                     Function<? super ELEMENTTYPE,DSTTYPE> aMapper,
                                                                     @Nonnull
                                                                     Collection<? super DSTTYPE> aDst)

findAllMapped

@Nonnull
 @ReturnsMutableCopy
default <DSTTYPE> void findAllMapped(@Nonnull
                                                                     Function<? super ELEMENTTYPE,DSTTYPE> aMapper,
                                                                     @Nonnull
                                                                     Consumer<? super DSTTYPE> aConsumer)

findAllMapped

@Nonnull
 @ReturnsMutableCopy
default <DSTTYPE> void findAllMapped(@Nullable
                                                                     Predicate<? super ELEMENTTYPE> aFilter,
                                                                     @Nonnull
                                                                     Function<? super ELEMENTTYPE,DSTTYPE> aMapper,
                                                                     @Nonnull
                                                                     Collection<? super DSTTYPE> aDst)

findAllMapped

@Nonnull
 @ReturnsMutableCopy
default <DSTTYPE> void findAllMapped(@Nullable
                                                                     Predicate<? super ELEMENTTYPE> aFilter,
                                                                     @Nonnull
                                                                     Function<? super ELEMENTTYPE,DSTTYPE> aMapper,
                                                                     @Nonnull
                                                                     Consumer<? super DSTTYPE> aConsumer)

findAllInstanceOf

@Nonnull
 @ReturnsMutableCopy
default <DSTTYPE extends ELEMENTTYPE> void findAllInstanceOf(@Nonnull
                                                                                             Class<DSTTYPE> aDstClass,
                                                                                             @Nonnull
                                                                                             Consumer<? super DSTTYPE> aConsumer)

findFirst

@Nullable
default ELEMENTTYPE findFirst(@Nullable
                                         Predicate<? super ELEMENTTYPE> aFilter)

findFirst

@Nullable
default ELEMENTTYPE findFirst(@Nullable
                                         Predicate<? super ELEMENTTYPE> aFilter,
                                         @Nullable
                                         ELEMENTTYPE aDefault)

findFirstMapped

@Nullable
default <DSTTYPE> DSTTYPE findFirstMapped(@Nullable
                                                     Predicate<? super ELEMENTTYPE> aFilter,
                                                     @Nonnull
                                                     Function<? super ELEMENTTYPE,DSTTYPE> aMapper)

findFirstMapped

@Nullable
default <DSTTYPE> DSTTYPE findFirstMapped(@Nullable
                                                     Predicate<? super ELEMENTTYPE> aFilter,
                                                     @Nonnull
                                                     Function<? super ELEMENTTYPE,DSTTYPE> aMapper,
                                                     @Nullable
                                                     DSTTYPE aDefault)

getCount

@Nonnegative
default int getCount(@Nullable
                                   Predicate<? super ELEMENTTYPE> aFilter)

containsAny

default boolean containsAny(@Nullable
                            Predicate<? super ELEMENTTYPE> aFilter)

containsNone

default boolean containsNone(@Nullable
                             Predicate<? super ELEMENTTYPE> aFilter)

containsOnly

default boolean containsOnly(@Nullable
                             Predicate<? super ELEMENTTYPE> aFilter)

getAtIndex

@Nullable
default ELEMENTTYPE getAtIndex(@Nonnegative
                                          int nIndex)

Safe collection element accessor method.

Parameters:

nIndex - The index to access. Should be ≥ 0.

Returns:

null if the element cannot be accessed.

getAtIndex

@Nullable
default ELEMENTTYPE getAtIndex(@Nonnegative
                                          int nIndex,
                                          @Nullable
                                          ELEMENTTYPE aDefault)

Safe collection element accessor method.

Parameters:

nIndex - The index to access. Should be ≥ 0.

aDefault - The value to be returned, if the index is out of bounds.

Returns:

The default parameter if the element cannot be accessed.

getAtIndex

@Nullable
default ELEMENTTYPE getAtIndex(@Nullable
                                          Predicate<? super ELEMENTTYPE> aFilter,
                                          @Nonnegative
                                          int nIndex)

getAtIndex

@Nullable
default ELEMENTTYPE getAtIndex(@Nullable
                                          Predicate<? super ELEMENTTYPE> aFilter,
                                          @Nonnegative
                                          int nIndex,
                                          @Nullable
                                          ELEMENTTYPE aDefault)

getAtIndexMapped

@Nullable
default <DSTTYPE> DSTTYPE getAtIndexMapped(@Nonnull
                                                      Predicate<? super ELEMENTTYPE> aFilter,
                                                      @Nonnegative
                                                      int nIndex,
                                                      @Nonnull
                                                      Function<? super ELEMENTTYPE,? extends DSTTYPE> aMapper)

getAtIndexMapped

@Nullable
default <DSTTYPE> DSTTYPE getAtIndexMapped(@Nonnull
                                                      Predicate<? super ELEMENTTYPE> aFilter,
                                                      @Nonnegative
                                                      int nIndex,
                                                      @Nonnull
                                                      Function<? super ELEMENTTYPE,? extends DSTTYPE> aMapper,
                                                      @Nullable
                                                      DSTTYPE aDefault)

getSorted

@Nonnull
default ICommonsList<ELEMENTTYPE> getSorted(@Nonnull
                                                      Comparator<? super ELEMENTTYPE> aComparator)

addIf

default void addIf(@Nullable
                   ELEMENTTYPE aValue,
                   @Nonnull
                   Predicate<ELEMENTTYPE> aFilter)

addIfNotNull

default void addIfNotNull(@Nullable
                          ELEMENTTYPE aValue)

addAll

default void addAll(@Nullable
                    ELEMENTTYPE... aValues)

Add an array of elements

Parameters:

aValues - The values to be added. May be null.

addAll

default void addAll(@Nullable
                    Enumeration<? extends ELEMENTTYPE> aEnum)

addAll

default void addAll(@Nullable
                    Iterator<? extends ELEMENTTYPE> aIter)

addAll

default void addAll(@Nullable
                    Iterable<? extends ELEMENTTYPE> aIterable)

addAllMapped

default <SRCTYPE> void addAllMapped(@Nullable
                                    Iterable<? extends SRCTYPE> aValues,
                                    @Nonnull
                                    Function<? super SRCTYPE,? extends ELEMENTTYPE> aMapper)

addAllMapped

default <SRCTYPE> void addAllMapped(@Nullable
                                    SRCTYPE[] aValues,
                                    @Nonnull
                                    Function<? super SRCTYPE,? extends ELEMENTTYPE> aMapper)

set

default void set(@Nullable
                 ELEMENTTYPE aValue)

Clear and add the passed value

Parameters:

aValue - The value to be added.

setAll

default void setAll(@Nullable
                    Collection<? extends ELEMENTTYPE> aValues)

Clear and add all provided values.

Parameters:

aValues - The values to be added. May be null.

setAll

default void setAll(@Nullable
                    ELEMENTTYPE... aValues)

Clear and add all provided values.

Parameters:

aValues - The values to be added. May be null.

removeAll

@Nonnull
default EChange removeAll()

getAsUnmodifiable

@Nonnull
default Collection<ELEMENTTYPE> getAsUnmodifiable()

iterator2

@Nonnull
default IIterableIterator<ELEMENTTYPE> iterator2()