speiger.src.collections.chars.collections

Interface CharCollection

All Superinterfaces:

CharIterable, java.util.Collection<java.lang.Character>, java.lang.Iterable<java.lang.Character>

All Known Subinterfaces:

CharList, CharNavigableSet, CharSet, CharSortedSet

All Known Implementing Classes:

AbstractCharCollection, AbstractCharList, AbstractCharSet, CharArrayList, CharArraySet, CharAVLTreeSet, CharCollections.EmptyCollection, CharCollections.SynchronizedCollection, CharCollections.UnmodifiableCollection, CharLinkedOpenCustomHashSet, CharLinkedOpenHashSet, CharOpenCustomHashSet, CharOpenHashSet, CharRBTreeSet, CharSets.UnmodifiableSet

public interface CharCollection
extends java.util.Collection<java.lang.Character>, CharIterable

A Type-Specific Collection that reduces (un)boxing

Method Summary

Modifier and Type	Method and Description
boolean	add(char o) A Type-Specific add function to reduce (un)boxing
default boolean	add(java.lang.Character o) Deprecated. Please use the corresponding type-specific function instead.
boolean	addAll(CharCollection c) A Type-Specific addAll function to reduce (un)boxing
boolean	contains(char o) A Type-Specific contains function to reduce (un)boxing
default boolean	contains(java.lang.Object o) Deprecated. Please use the corresponding type-specific function instead.
boolean	containsAll(CharCollection c) A Type-Specific containsAll function to reduce (un)boxing
boolean	containsAny(CharCollection c) A Type-Specific containsAny function to reduce (un)boxing
boolean	containsAny(java.util.Collection<?> c) Deprecated.
CharIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
default java.util.stream.IntStream	parallelPrimitiveStream() Returns a Java-Type-Specific Parallel Stream to reduce boxing/unboxing.
default java.util.stream.IntStream	primitiveStream() Returns a Java-Type-Specific Stream to reduce boxing/unboxing.
boolean	remChar(char o) A Type-Specific remove function that reduces (un)boxing.
default boolean	remIf(java.util.function.IntPredicate filter) A Type-Specific removeIf function to reduce (un)boxing.
default boolean	remove(java.lang.Object o) Deprecated. Please use the corresponding type-specific function instead.
boolean	removeAll(CharCollection c) A Type-Specific removeAll function that reduces (un)boxing.
default boolean	removeIf(java.util.function.Predicate<? super java.lang.Character> filter) Deprecated. Please use the corresponding type-specific function instead.
boolean	retainAll(CharCollection c) A Type-Specific retainAll function that reduces (un)boxing.
default CharSplititerator	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
char[]	toCharArray() A Type-Specific toArray function that delegates to toCharArray(char[]) with a newly created array.
char[]	toCharArray(char[] a) A Type-Specific toArray function that reduces (un)boxing.

Methods inherited from interface java.util.Collection

addAll, clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, retainAll, size, stream, toArray, toArray

Methods inherited from interface speiger.src.collections.chars.collections.CharIterable

forEach, forEach

Method Detail

add

boolean add(char o)

A Type-Specific add function to reduce (un)boxing

Parameters:

o - the element that should be added

Returns:

true if the element was added to the collection

addAll

boolean addAll(CharCollection c)

A Type-Specific addAll function to reduce (un)boxing

Parameters:

c - the collection of elements that should be added

Returns:

true if elements were added into the collection

contains

boolean contains(char o)

A Type-Specific contains function to reduce (un)boxing

Parameters:

o - the element that is checked for

Returns:

true if the element is found in the collection

containsAll

boolean containsAll(CharCollection c)

A Type-Specific containsAll function to reduce (un)boxing

Parameters:

c - the collection of elements that should be tested for

Returns:

true if all the element is found in the collection

containsAny

boolean containsAny(CharCollection c)

A Type-Specific containsAny function to reduce (un)boxing

Parameters:

c - the collection of elements that should be tested for

Returns:

true if any element was found

containsAny

@Deprecated
boolean containsAny(java.util.Collection<?> c)

Deprecated.

Returns true if any element of the Collection is found in the provided collection. A Small Optimization function to find out of any element is present when comparing collections and not all of them.

Parameters:

c - the collection of elements that should be tested for

Returns:

true if any element was found.

remChar

boolean remChar(char o)

A Type-Specific remove function that reduces (un)boxing.

Parameters:

o - the element that should be removed

Returns:

true if the element was removed

See Also:

Collection.remove(Object)

removeAll

boolean removeAll(CharCollection c)

A Type-Specific removeAll function that reduces (un)boxing.

Parameters:

c - the collection of elements that should be removed

Returns:

true if any element was removed

See Also:

Collection.removeAll(Collection)

retainAll

boolean retainAll(CharCollection c)

A Type-Specific retainAll function that reduces (un)boxing.

Parameters:

c - the collection of elements that should be kept

Returns:

true if any element was removed

See Also:

Collection.retainAll(Collection)

toCharArray

char[] toCharArray()

A Type-Specific toArray function that delegates to toCharArray(char[]) with a newly created array.

Returns:

an array containing all of the elements in this collection

See Also:

Collection.toArray()

toCharArray

char[] toCharArray(char[] a)

A Type-Specific toArray function that reduces (un)boxing.

Parameters:

a - array that the elements should be injected to. If null or to small a new array with the right size is created

Returns:

an array containing all of the elements in this collection

See Also:

Collection.toArray(Object[])

removeIf

@Deprecated
default boolean removeIf(java.util.function.Predicate<? super java.lang.Character> filter)

Deprecated. Please use the corresponding type-specific function instead.

This default implementation delegates to the corresponding type-specific function.

Specified by:

removeIf in interface java.util.Collection<java.lang.Character>

remIf

default boolean remIf(java.util.function.IntPredicate filter)

A Type-Specific removeIf function to reduce (un)boxing.

Removes elements that were selected by the filter

Parameters:

filter - Filters the elements that should be removed

Returns:

true if the collection was modified

Throws:

java.lang.NullPointerException - if filter is null

See Also:

Collection.removeIf(Predicate)

add

@Deprecated
default boolean add(java.lang.Character o)

Deprecated. Please use the corresponding type-specific function instead.

This default implementation delegates to the corresponding type-specific function.

Specified by:

add in interface java.util.Collection<java.lang.Character>

contains

@Deprecated
default boolean contains(java.lang.Object o)

Deprecated. Please use the corresponding type-specific function instead.

This default implementation delegates to the corresponding type-specific function.

Specified by:

contains in interface java.util.Collection<java.lang.Character>

remove

@Deprecated
default boolean remove(java.lang.Object o)

Deprecated. Please use the corresponding type-specific function instead.

This default implementation delegates to the corresponding type-specific function.

Specified by:

remove in interface java.util.Collection<java.lang.Character>

iterator

CharIterator iterator()

Returns a Type-Specific Iterator to reduce (un)boxing

Specified by:

iterator in interface CharIterable

Specified by:

iterator in interface java.util.Collection<java.lang.Character>

Specified by:

iterator in interface java.lang.Iterable<java.lang.Character>

Returns:

a iterator of the collection

See Also:

Collection.iterator()

primitiveStream

default java.util.stream.IntStream primitiveStream()

Returns a Java-Type-Specific Stream to reduce boxing/unboxing.

Returns:

a Stream of the closest java type

parallelPrimitiveStream

default java.util.stream.IntStream parallelPrimitiveStream()

Returns a Java-Type-Specific Parallel Stream to reduce boxing/unboxing.

Returns:

a Stream of the closest java type

spliterator

default CharSplititerator spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Specified by:

spliterator in interface CharIterable

Specified by:

spliterator in interface java.util.Collection<java.lang.Character>

Specified by:

spliterator in interface java.lang.Iterable<java.lang.Character>

Returns:

type specific splititerator