speiger.src.collections.chars.sets

Class CharArraySet

java.lang.Object

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

speiger.src.collections.chars.collections.AbstractCharCollection

speiger.src.collections.chars.sets.AbstractCharSet

speiger.src.collections.chars.sets.CharArraySet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Character>, java.util.Collection<java.lang.Character>, java.util.Set<java.lang.Character>, CharCollection, CharIterable, CharOrderedSet, CharSet, ISizeProvider

public class CharArraySet
extends AbstractCharSet
implements CharOrderedSet

A Type Specific ArraySet implementation. That is based around the idea of List.indexOf(Object) for no duplication. Unless a array constructor is used the ArraySet does not allow for duplication. This implementation does not shrink the backing array

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.utils.ISizeProvider

ISizeProvider.CollectionSize

Constructor Summary

Constructors

Constructor and Description
CharArraySet() Default Constructor
CharArraySet(char[] array) Constructur using initial Array
CharArraySet(char[] array, int length) Constructur using initial Array
CharArraySet(CharCollection c) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
CharArraySet(CharSet s) A Helper constructor that fast copies the element out of a set into the ArraySet.
CharArraySet(java.util.Collection<? extends java.lang.Character> c) Deprecated.
CharArraySet(int capacity) Minimum Capacity Constructor
CharArraySet(java.util.Set<? extends java.lang.Character> s) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	add(char o) A Type-Specific add function to reduce (un)boxing
boolean	addAndMoveToFirst(char o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(char o) A customized add method that allows you to insert into the last index.
void	clear()
boolean	contains(char e) A Type-Specific implementation of contains.
CharArraySet	copy() A Function that does a shallow clone of the Collection itself.
int	count(CharPredicate filter) Helper function to reduce stream usage that allows to count the valid elements.
char	findFirst(CharPredicate filter) Helper function to reduce stream usage that allows to filter for the first match.
char	firstChar() A method to get the first element in the set
void	forEach(CharConsumer action) A Type Specific foreach function that reduces (un)boxing
<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.
void	forEachIndexed(IntCharConsumer action) A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.
CharBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
CharBidirectionalIterator	iterator(char fromElement) A type Specific Iterator starting from a given key
char	lastChar() A method to get the last element in the set
boolean	matchesAll(CharPredicate filter) Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(CharPredicate filter) Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(CharPredicate filter) Helper function to reduce stream usage that allows to filter for no matches.
boolean	moveToFirst(char o) A specific move method to move a given key to the first index.
boolean	moveToLast(char o) A specific move method to move a given key to the last index.
char	pollFirstChar() A method to get and remove the first element in the set
char	pollLastChar() A method to get and remove the last element in the set
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	remIf(java.util.function.IntPredicate filter) A Type-Specific removeIf function to reduce (un)boxing.
boolean	remove(char o) A Type Specific remove function to reduce boxing/unboxing
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	removeAll(java.util.Collection<?> c) Deprecated.
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.
boolean	retainAll(java.util.Collection<?> c) Deprecated.
int	size()
java.lang.Object[]	toArray() Deprecated.
<E> E[]	toArray(E[] a) Deprecated.
char[]	toCharArray(char[] a) A Type-Specific implementation of toArray.

Methods inherited from class speiger.src.collections.chars.sets.AbstractCharSet

equals, hashCode

Methods inherited from class speiger.src.collections.chars.collections.AbstractCharCollection

add, addAll, addAll, contains, containsAll, containsAll, containsAny, containsAny, remChar, remove, toCharArray

Methods inherited from class java.util.AbstractCollection

isEmpty, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.chars.sets.CharOrderedSet

spliterator, synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.chars.sets.CharSet

add, contains, remChar, remove

Methods inherited from interface java.util.Set

addAll, containsAll, equals, hashCode, isEmpty

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

addAll, addAll, addAll, addAll, containsAll, containsAny, containsAny, parallelPrimitiveStream, pour, primitiveStream, removeIf, toCharArray

Methods inherited from interface java.util.Collection

parallelStream, stream

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

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

Methods inherited from interface speiger.src.collections.utils.ISizeProvider

of

Constructor Detail

CharArraySet

public CharArraySet()

Default Constructor

CharArraySet

public CharArraySet(int capacity)

Minimum Capacity Constructor

Parameters:

capacity - the minimum capacity of the internal array

Throws:

java.lang.NegativeArraySizeException - if the capacity is negative

CharArraySet

public CharArraySet(char[] array)

Constructur using initial Array

Parameters:

array - the array that should be used for set.

CharArraySet

public CharArraySet(char[] array,
                    int length)

Constructur using initial Array

Parameters:

array - the array that should be used for set.

length - the amount of elements present within the array

Throws:

java.lang.NegativeArraySizeException - if the length is negative

CharArraySet

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

Deprecated.

A Helper constructor that allows to create a Set with exactly the same values as the provided collection.

Parameters:

c - the elements that should be added to the set.

Note:

this slowly checks every element to remove duplicates

CharArraySet

public CharArraySet(CharCollection c)

A Helper constructor that allows to create a Set with exactly the same values as the provided collection.

Parameters:

c - the elements that should be added to the set.

Note:

this slowly checks every element to remove duplicates

CharArraySet

@Deprecated
public CharArraySet(java.util.Set<? extends java.lang.Character> s)

Deprecated.

A Helper constructor that fast copies the element out of a set into the ArraySet. Since it is assumed that there is no duplication in the first place

Parameters:

s - the set the element should be taken from

CharArraySet

public CharArraySet(CharSet s)

A Helper constructor that fast copies the element out of a set into the ArraySet. Since it is assumed that there is no duplication in the first place

Parameters:

s - the set the element should be taken from

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

addAndMoveToFirst

public boolean addAndMoveToFirst(char o)

Description copied from interface: CharOrderedSet

A customized add method that allows you to insert into the first index.

Specified by:

addAndMoveToFirst in interface CharOrderedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

addAndMoveToLast

public boolean addAndMoveToLast(char o)

Description copied from interface: CharOrderedSet

A customized add method that allows you to insert into the last index.

Specified by:

addAndMoveToLast in interface CharOrderedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

moveToFirst

public boolean moveToFirst(char o)

Description copied from interface: CharOrderedSet

A specific move method to move a given key to the first index.

Specified by:

moveToFirst in interface CharOrderedSet

Parameters:

o - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(char o)

Description copied from interface: CharOrderedSet

A specific move method to move a given key to the last index.

Specified by:

moveToLast in interface CharOrderedSet

Parameters:

o - that should be moved to the first last

Returns:

true if the value was moved.

contains

public boolean contains(char e)

Description copied from class: AbstractCharCollection

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

Overrides:

contains in class AbstractCharCollection

Parameters:

e - the element that should be searched for.

Returns:

true if the value was found.

firstChar

public char firstChar()

Description copied from interface: CharOrderedSet

A method to get the first element in the set

Specified by:

firstChar in interface CharOrderedSet

Returns:

first element in the set

lastChar

public char lastChar()

Description copied from interface: CharOrderedSet

A method to get the last element in the set

Specified by:

lastChar in interface CharOrderedSet

Returns:

last element in the set

removeAll

public boolean removeAll(CharCollection c)

Description copied from class: AbstractCharCollection

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

Overrides:

removeAll in class AbstractCharCollection

Parameters:

c - the elements that should be deleted

Returns:

true if the collection was modified.

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

Overrides:

removeAll in class AbstractCharCollection

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 class: AbstractCharCollection

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

Overrides:

retainAll in class AbstractCharCollection

Parameters:

c - the elements that should be kept

Returns:

true if the collection was modified.

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

Overrides:

retainAll in class AbstractCharCollection

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)

removeAll

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

Deprecated.

Specified by:

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

Specified by:

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

Overrides:

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

retainAll

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

Deprecated.

Specified by:

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

Specified by:

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

Overrides:

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

remove

public boolean remove(char o)

Description copied from interface: CharSet

A Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface CharSet

Parameters:

o - the element that should be removed

Returns:

true if the element was removed

pollFirstChar

public char pollFirstChar()

Description copied from interface: CharOrderedSet

A method to get and remove the first element in the set

Specified by:

pollFirstChar in interface CharOrderedSet

Returns:

first element in the set

pollLastChar

public char pollLastChar()

Description copied from interface: CharOrderedSet

A method to get and remove the last element in the set

Specified by:

pollLastChar in interface CharOrderedSet

Returns:

last element in the set

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)

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)

forEachIndexed

public void forEachIndexed(IntCharConsumer action)

Description copied from interface: CharIterable

A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.

Specified by:

forEachIndexed in interface CharIterable

Parameters:

action - The action to be performed for each element

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(CharPredicate 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(CharPredicate 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(CharPredicate 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.

findFirst

public char findFirst(CharPredicate 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.

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

count

public int count(CharPredicate 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

iterator

public CharBidirectionalIterator 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 java.util.Set<java.lang.Character>

Specified by:

iterator in interface CharCollection

Specified by:

iterator in interface CharIterable

Specified by:

iterator in interface CharOrderedSet

Specified by:

iterator in interface CharSet

Specified by:

iterator in class AbstractCharSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

public CharBidirectionalIterator iterator(char fromElement)

Description copied from interface: CharOrderedSet

A type Specific Iterator starting from a given key

Specified by:

iterator in interface CharOrderedSet

Parameters:

fromElement - the element the iterator should start from

Returns:

a iterator starting from the given element

copy

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

Specified by:

copy in interface CharOrderedSet

Specified by:

copy in interface CharSet

Overrides:

copy in class AbstractCharSet

Returns:

a Shallow Copy of the collection

clear

public void clear()

Specified by:

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

Specified by:

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

Overrides:

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

size

public int size()

Specified by:

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

Specified by:

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

Specified by:

size in interface ISizeProvider

Specified by:

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

Returns:

the size of the implementing Collection

toCharArray

public char[] toCharArray(char[] a)

Description copied from class: AbstractCharCollection

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

Specified by:

toCharArray in interface CharCollection

Overrides:

toCharArray in class AbstractCharCollection

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

toArray

@Deprecated
public java.lang.Object[] toArray()

Deprecated.

Specified by:

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

Specified by:

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

Overrides:

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

toArray

@Deprecated
public <E> E[] toArray(E[] a)

Deprecated.

Specified by:

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

Specified by:

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

Overrides:

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