speiger.src.collections.chars.utils

Class CharCollections.UnmodifiableCollection

java.lang.Object

speiger.src.collections.chars.utils.CharCollections.UnmodifiableCollection

All Implemented Interfaces:

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

Direct Known Subclasses:

CharSets.UnmodifiableSet

Enclosing class:

CharCollections

public static class CharCollections.UnmodifiableCollection
extends java.lang.Object
implements CharCollection

Unmodifyable Collection Wrapper for the unmodifyableCollection method

Method Summary

Modifier and Type	Method and Description
boolean	add(char o) A Type-Specific add function to reduce (un)boxing
boolean	addAll(char[] e, int offset, int length) A Type-Specific Array based addAll method to reduce the amount of Wrapping
boolean	addAll(CharCollection c) A Type-Specific addAll function to reduce (un)boxing
boolean	addAll(java.util.Collection<? extends java.lang.Character> c)
void	clear()
boolean	contains(char o) A Type-Specific contains function to reduce (un)boxing
boolean	containsAll(CharCollection c) A Type-Specific containsAll function to reduce (un)boxing
boolean	containsAll(java.util.Collection<?> c) Deprecated.
boolean	containsAny(CharCollection c) A Type-Specific containsAny function to reduce (un)boxing
boolean	containsAny(java.util.Collection<?> c) Deprecated.
CharCollection	copy() A Function that does a shallow clone of the Collection itself.
int	count(Char2BooleanFunction filter) Helper function to reduce stream usage that allows to count the valid elements.
boolean	equals(java.lang.Object obj)
char	findFirst(Char2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for the first match.
void	forEach(CharConsumer action) A Type Specific foreach function that reduces (un)boxing
void	forEach(java.util.function.Consumer<? super java.lang.Character> action) Deprecated.
<E> void	forEach(E input, ObjectCharConsumer<E> action) Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
int	hashCode()
boolean	isEmpty()
CharIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
boolean	matchesAll(Char2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(Char2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(Char2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for no matches.
char	reduce(char identity, CharCharUnaryOperator operator) Performs a reduction on the elements of this Iterable
char	reduce(CharCharUnaryOperator operator) Performs a reduction on the elements of this Iterable
boolean	remChar(char o) A Type-Specific remove function that reduces (un)boxing.
boolean	remIf(java.util.function.IntPredicate filter) A Type-Specific removeIf function to reduce (un)boxing.
boolean	remove(java.lang.Object o) Deprecated.
boolean	removeAll(CharCollection c) A Type-Specific removeAll function that reduces (un)boxing.
boolean	removeAll(CharCollection c, CharConsumer r) A Type-Specific removeAll function that reduces (un)boxing.
boolean	removeAll(java.util.Collection<?> c) Deprecated.
boolean	removeIf(java.util.function.Predicate<? super java.lang.Character> filter) Deprecated.
boolean	retainAll(CharCollection c) A Type-Specific retainAll function that reduces (un)boxing.
boolean	retainAll(CharCollection c, CharConsumer r) A Type-Specific retainAll function that reduces (un)boxing.
boolean	retainAll(java.util.Collection<?> c) Deprecated.
int	size()
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)
char[]	toCharArray() A Type-Specific toArray function that delegates to CharCollection.toCharArray(char[]) with a newly created array.
char[]	toCharArray(char[] a) A Type-Specific toArray function that reduces (un)boxing.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

add, addAll, addAll, contains, parallelPrimitiveStream, pour, primitiveStream, spliterator, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Collection

parallelStream, stream

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

arrayflatMap, asAsync, distinct, filter, flatMap, limit, map, peek, pourAsList, pourAsSet, sorted

Method Detail

add

public boolean add(char o)

Description copied from interface: CharCollection

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

Specified by:

add in interface CharCollection

Parameters:

o - the element that should be added

Returns:

true if the element was added to the collection

addAll

public boolean addAll(java.util.Collection<? extends java.lang.Character> c)

Specified by:

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

addAll

public boolean addAll(CharCollection c)

Description copied from interface: CharCollection

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

Specified by:

addAll in interface CharCollection

Parameters:

c - the collection of elements that should be added

Returns:

true if elements were added into the collection

addAll

public boolean addAll(char[] e,
                      int offset,
                      int length)

Description copied from interface: CharCollection

A Type-Specific Array based addAll method to reduce the amount of Wrapping

Specified by:

addAll in interface CharCollection

Parameters:

e - the elements that should be added

offset - where to start within the array

length - how many elements of the array should be added

Returns:

if the collection was modified

contains

public boolean contains(char o)

Description copied from interface: CharCollection

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

Specified by:

contains in interface CharCollection

Parameters:

o - the element that is checked for

Returns:

true if the element is found in the collection

containsAll

public boolean containsAll(CharCollection c)

Description copied from interface: CharCollection

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

Specified by:

containsAll in interface CharCollection

Parameters:

c - the collection of elements that should be tested for

Returns:

true if all the element is found in the collection

containsAny

public boolean containsAny(CharCollection c)

Description copied from interface: CharCollection

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

Specified by:

containsAny in interface CharCollection

Parameters:

c - the collection of elements that should be tested for

Returns:

true if any element was found

containsAny

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

Deprecated.

Description copied from interface: CharCollection

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.

Specified by:

containsAny in interface CharCollection

Parameters:

c - the collection of elements that should be tested for

Returns:

true if any element was found.

containsAll

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

Deprecated.

Specified by:

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

size

public int size()

Specified by:

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

isEmpty

public boolean isEmpty()

Specified by:

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

iterator

public CharIterator iterator()

Description copied from interface: CharCollection

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

Specified by:

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

Specified by:

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

Specified by:

iterator in interface CharCollection

Specified by:

iterator in interface CharIterable

Returns:

a iterator of the collection

See Also:

Collection.iterator()

copy

public CharCollection copy()

Description copied from interface: CharCollection

A Function that does a shallow clone of the Collection itself. This function is more optimized then a copy constructor since the Collection does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk

Specified by:

copy in interface CharCollection

Returns:

a Shallow Copy of the collection

remove

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

Deprecated.

Description copied from interface: CharCollection

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

Specified by:

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

Specified by:

remove in interface CharCollection

removeAll

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

Deprecated.

Specified by:

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

retainAll

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

Deprecated.

Specified by:

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

removeIf

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

Deprecated.

Description copied from interface: CharCollection

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

Specified by:

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

Specified by:

removeIf in interface CharCollection

remChar

public boolean remChar(char o)

Description copied from interface: CharCollection

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

Specified by:

remChar in interface CharCollection

Parameters:

o - the element that should be removed

Returns:

true if the element was removed

See Also:

Collection.remove(Object)

removeAll

public boolean removeAll(CharCollection c)

Description copied from interface: CharCollection

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

Specified by:

removeAll in interface CharCollection

Parameters:

c - the collection of elements that should be removed

Returns:

true if any element was removed

See Also:

Collection.removeAll(Collection)

removeAll

public boolean removeAll(CharCollection c,
                         CharConsumer r)

Description copied from interface: CharCollection

A Type-Specific removeAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.

Specified by:

removeAll in interface CharCollection

Parameters:

c - the collection of elements that should be removed

r - elements that got removed

Returns:

true if any element was removed

See Also:

Collection.removeAll(Collection)

retainAll

public boolean retainAll(CharCollection c)

Description copied from interface: CharCollection

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

Specified by:

retainAll in interface CharCollection

Parameters:

c - the collection of elements that should be kept

Returns:

true if any element was removed

See Also:

Collection.retainAll(Collection)

retainAll

public boolean retainAll(CharCollection c,
                         CharConsumer r)

Description copied from interface: CharCollection

A Type-Specific retainAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.

Specified by:

retainAll in interface CharCollection

Parameters:

c - the collection of elements that should be kept

r - elements that got removed

Returns:

true if any element was removed

See Also:

Collection.retainAll(Collection)

remIf

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

Description copied from interface: CharCollection

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

Removes elements that were selected by the filter

Specified by:

remIf in interface CharCollection

Parameters:

filter - Filters the elements that should be removed

Returns:

true if the collection was modified

See Also:

Collection.removeIf(Predicate)

clear

public void clear()

Specified by:

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

toArray

public java.lang.Object[] toArray()

Specified by:

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

toArray

public <T> T[] toArray(T[] a)

Specified by:

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

toCharArray

public char[] toCharArray()

Description copied from interface: CharCollection

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

Specified by:

toCharArray in interface CharCollection

Returns:

an array containing all of the elements in this collection

See Also:

Collection.toArray()

toCharArray

public char[] toCharArray(char[] a)

Description copied from interface: CharCollection

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

Specified by:

toCharArray in interface CharCollection

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[])

forEach

public void forEach(CharConsumer action)

Description copied from interface: CharIterable

A Type Specific foreach function that reduces (un)boxing

Specified by:

forEach in interface CharIterable

Parameters:

action - The action to be performed for each element

See Also:

Iterable.forEach(Consumer)

forEach

@Deprecated
public void forEach(java.util.function.Consumer<? super java.lang.Character> action)

Deprecated.

Description copied from interface: CharIterable

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

Specified by:

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

Specified by:

forEach in interface CharIterable

hashCode

public int hashCode()

Specified by:

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

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Specified by:

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

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

forEach

public <E> void forEach(E input,
                        ObjectCharConsumer<E> action)

Description copied from interface: CharIterable

Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.

Specified by:

forEach in interface CharIterable

Type Parameters:

E - the generic type of the Object

Parameters:

input - the object that should be included

action - The action to be performed for each element

matchesAny

public boolean matchesAny(Char2BooleanFunction filter)

Description copied from interface: CharIterable

Helper function to reduce stream usage that allows to filter for any matches.

Specified by:

matchesAny in interface CharIterable

Parameters:

filter - that should be applied

Returns:

true if any matches were found

matchesNone

public boolean matchesNone(Char2BooleanFunction filter)

Description copied from interface: CharIterable

Helper function to reduce stream usage that allows to filter for no matches.

Specified by:

matchesNone in interface CharIterable

Parameters:

filter - that should be applied

Returns:

true if no matches were found

matchesAll

public boolean matchesAll(Char2BooleanFunction filter)

Description copied from interface: CharIterable

Helper function to reduce stream usage that allows to filter for all matches.

Specified by:

matchesAll in interface CharIterable

Parameters:

filter - that should be applied

Returns:

true if all matches.

reduce

public char reduce(char identity,
                   CharCharUnaryOperator operator)

Description copied from interface: CharIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface CharIterable

Parameters:

identity - the start value

operator - the operation that should be applied

Returns:

the reduction result, returns identity if nothing was found

reduce

public char reduce(CharCharUnaryOperator operator)

Description copied from interface: CharIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface CharIterable

Parameters:

operator - the operation that should be applied

Returns:

the reduction result, returns null value if nothing was found

findFirst

public char findFirst(Char2BooleanFunction filter)

Description copied from interface: CharIterable

Helper function to reduce stream usage that allows to filter for the first match.

Specified by:

findFirst in interface CharIterable

Parameters:

filter - that should be applied

Returns:

the found value or the null equivalent variant.

count

public int count(Char2BooleanFunction filter)

Description copied from interface: CharIterable

Helper function to reduce stream usage that allows to count the valid elements.

Specified by:

count in interface CharIterable

Parameters:

filter - that should be applied

Returns:

the amount of Valid Elements