speiger.src.collections.chars.collections

Class AbstractCharCollection

java.lang.Object

java.util.AbstractCollection<java.lang.Character>

speiger.src.collections.chars.collections.AbstractCharCollection

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCharList, AbstractCharSet, CharCollections.EmptyCollection

public abstract class AbstractCharCollection
extends java.util.AbstractCollection<java.lang.Character>
implements CharCollection

Abstract Type Specific Collection that reduces boxing/unboxing

Constructor Summary

Constructors

Constructor and Description
AbstractCharCollection()

Method Summary

Modifier and Type	Method and Description
boolean	add(java.lang.Character e) Deprecated. Please use the corresponding type-specific function instead.
boolean	addAll(CharCollection c) A Type-Specific addAll function to reduce (un)boxing
boolean	addAll(java.util.Collection<? extends java.lang.Character> c) Deprecated. Please use the corresponding type-specific function instead.
boolean	contains(char e) A Type-Specific implementation of contains.
boolean	contains(java.lang.Object e) Deprecated. Please use the corresponding type-specific function instead.
boolean	containsAll(CharCollection c) A Type-Specific implementation of containsAll.
boolean	containsAll(java.util.Collection<?> c)
boolean	containsAny(CharCollection c) This implementation iterates over the elements of the collection and checks if they are stored in this collection.
boolean	containsAny(java.util.Collection<?> c) Deprecated.
CharCollection	copy() A Function that does a shallow clone of the Collection itself.
abstract CharIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
boolean	remChar(char e) A Type-Specific implementation of remove.
boolean	remove(java.lang.Object e) Deprecated. Please use the corresponding type-specific function instead.
boolean	removeAll(CharCollection c) A Type-Specific implementation of removeAll.
boolean	removeAll(CharCollection c, CharConsumer r) A Type-Specific removeAll function that reduces (un)boxing.
boolean	retainAll(CharCollection c) A Type-Specific implementation of retainAll.
boolean	retainAll(CharCollection c, CharConsumer r) A Type-Specific retainAll function that reduces (un)boxing.
char[]	toCharArray() A Type-Specific implementation of toArray that links to toCharArray(char[]) with a newly created array.
char[]	toCharArray(char[] a) A Type-Specific implementation of toArray.

Methods inherited from class java.util.AbstractCollection

clear, isEmpty, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

add, addAll, addAll, addAll, parallelPrimitiveStream, pour, primitiveStream, remIf, removeIf, spliterator, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Collection

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

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

arrayflatMap, asAsync, count, distinct, filter, findFirst, flatMap, forEach, forEach, forEach, limit, map, matchesAll, matchesAny, matchesNone, peek, pourAsList, pourAsSet, reduce, reduce, sorted

Constructor Detail

AbstractCharCollection

public AbstractCharCollection()

Method Detail

iterator

public abstract 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

Specified by:

iterator in class java.util.AbstractCollection<java.lang.Character>

Returns:

a iterator of the collection

See Also:

Collection.iterator()

add

@Deprecated
public boolean add(java.lang.Character e)

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

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

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

Specified by:

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

Specified by:

add in interface CharCollection

Overrides:

add in class java.util.AbstractCollection<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

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

contains

@Deprecated
public boolean contains(java.lang.Object e)

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

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

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

Specified by:

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

Specified by:

contains in interface CharCollection

Overrides:

contains in class java.util.AbstractCollection<java.lang.Character>

contains

public boolean contains(char e)

A Type-Specific implementation of contains. This implementation iterates over the elements and returns true if the value match.

Specified by:

contains in interface CharCollection

Parameters:

e - the element that should be searched for.

Returns:

true if the value was found.

addAll

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

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

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

Specified by:

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

Overrides:

addAll in class java.util.AbstractCollection<java.lang.Character>

containsAll

public boolean containsAll(CharCollection c)

A Type-Specific implementation of containsAll. This implementation iterates over all elements and checks all elements are present in the other collection.

Specified by:

containsAll in interface CharCollection

Parameters:

c - the collection that should be checked if it contains all elements.

Returns:

true if all elements were found in the collection

Throws:

java.lang.NullPointerException - if the collection is null

containsAll

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

Specified by:

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

Overrides:

containsAll in class java.util.AbstractCollection<java.lang.Character>

containsAny

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

Deprecated.

This implementation iterates over the elements of the collection and checks if they are stored in this collection

Specified by:

containsAny in interface CharCollection

Parameters:

c - the elements that should be checked for

Returns:

true if any element is in this collection

Throws:

java.lang.NullPointerException - if the collection is null

containsAny

public boolean containsAny(CharCollection c)

This implementation iterates over the elements of the collection and checks if they are stored in this collection.

Specified by:

containsAny in interface CharCollection

Parameters:

c - the elements that should be checked for

Returns:

true if any element is in this collection

Throws:

java.lang.NullPointerException - if the collection is null

remove

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

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

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

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

Overrides:

remove in class java.util.AbstractCollection<java.lang.Character>

remChar

public boolean remChar(char e)

A Type-Specific implementation of remove. This implementation iterates over the elements until it finds the element that is searched for or it runs out of elements. It stops after finding the first element

Specified by:

remChar in interface CharCollection

Parameters:

e - the element that is searched for

Returns:

true if the element was found and removed.

See Also:

Collection.remove(Object)

removeAll

public boolean removeAll(CharCollection c)

A Type-Specific implementation of removeAll. This Implementation iterates over all elements and removes them as they were found in the other collection.

Specified by:

removeAll in interface CharCollection

Parameters:

c - the elements that should be deleted

Returns:

true if the collection was modified.

Throws:

java.lang.NullPointerException - if the collection is null

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)

A Type-Specific implementation of retainAll. This Implementation iterates over all elements and removes them as they were not found in the other collection.

Specified by:

retainAll in interface CharCollection

Parameters:

c - the elements that should be kept

Returns:

true if the collection was modified.

Throws:

java.lang.NullPointerException - if the collection is null

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)

toCharArray

public char[] toCharArray()

A Type-Specific implementation of toArray that links to 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)

A Type-Specific implementation of toArray. This implementation iterates over all elements and unwraps them into primitive type.

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