org.joda.primitives.collection.impl

Class AbstractCharCollection

java.lang.Object

org.joda.primitives.collection.impl.AbstractPrimitiveCollectable<java.lang.Character>

org.joda.primitives.collection.impl.AbstractCharCollection

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCharList, ArrayCharCollection

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

Abstract base class for collections of primitive char elements.

This class implements Collection allowing seamless integration with other APIs.

The iterator and size must be implemented by subclases. To make the subclass modifiable, the add(char) and iterator remove() methods must also be implemented. Subclasses may override other methods to increase efficiency.

Since:

1.0

Version:

CODE GENERATED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCharCollection() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	add(char value) Adds a primitive value to this collection (optional operation).
boolean	add(java.lang.Character value) Adds the Character value to this collection (optional operation).
boolean	addAll(char[] values) Adds an array of primitive values to this collection (optional operation).
boolean	addAll(char startInclusive, char endInclusive) Adds a range of primitive values to this collection (optional operation).
boolean	addAll(CharCollection values) Adds a collection of primitive values to this collection (optional operation).
boolean	addAll(java.util.Collection<? extends java.lang.Character> coll) Adds a collection of Character values to this collection (optional operation).
protected void	arrayCopy(int fromIndex, char[] dest, int destIndex, int size) Copies data from this collection into the specified array.
protected void	checkAddModifiable() Check whether add is suported and throw an exception.
protected void	checkRemoveModifiable() Check whether remove is suported and throw an exception.
void	clear() Clears the collection/map of all elements (optional operation).
boolean	contains(char value) Checks whether this collection contains a specified primitive value.
boolean	contains(java.lang.Object value) Checks whether this collection contains a specified Character value.
boolean	containsAll(char[] values) Checks if this collection contains all of the values in the specified array.
boolean	containsAll(char startInclusive, char endInclusive) Checks if this collection contain all the values in the specified range.
boolean	containsAll(CharCollection values) Checks if this collection contains all of the values in the specified collection.
boolean	containsAll(java.util.Collection<?> coll) Checks if the collection contains all of the primitive values.
boolean	containsAny(char[] values) Checks if this collection contains any of the values in the specified array.
boolean	containsAny(char startInclusive, char endInclusive) Checks if this collection contain some of the values in the specified range.
boolean	containsAny(CharCollection values) Checks if this collection contains any of the values in the specified collection.
boolean	containsAny(java.util.Collection<?> coll) Checks if the collection contains any of the primitive values in the array.
protected boolean	isAddModifiable() Are the add methods supported.
boolean	isModifiable() Is the collection modifiable in any way.
protected boolean	isRemoveModifiable() Are the remove methods supported.
protected boolean	isToPrimitivePossible(java.lang.Object value) Checks if the object can be converted to a primitive successfully.
boolean	remove(java.lang.Object value) Removes the first occurrance of the specified Character value from this collection (optional operation).
boolean	removeAll(char value) Removes all occurrences of the specified primitive value from this collection.
boolean	removeAll(char[] values) Removes all occurrences from this collection of each primitive in the specified array.
boolean	removeAll(char startInclusive, char endInclusive) Removes all occurrences of a range of primitive values from this collection.
boolean	removeAll(CharCollection values) Removes all occurrences from this collection of each primitive in the specified collection.
boolean	removeAll(java.util.Collection<?> coll) Removes each of a collection of Character values from this collection (optional operation).
boolean	removeFirst(char value) Removes the first occurrence of the specified primitive value from this collection
boolean	retainAll(char[] values) Retains each element of this collection that is present in the specified array removing all other values.
boolean	retainAll(char startInclusive, char endInclusive) Retains all occurences of a range of primitive values within this collection removing all values outside the range (optional operation).
boolean	retainAll(CharCollection values) Retains each element of this collection that is present in the specified collection removing all other values.
boolean	retainAll(java.util.Collection<?> coll) Retains each of a collection of Character values, removing other values (optional operation).
java.lang.Object[]	toArray() Gets the collection as an array of Character.
<T> T[]	toArray(T[] array) Gets the collection as an array, using the array provided.
char[]	toCharArray() Gets the elements of this collection as an array.
char[]	toCharArray(char[] array, int startIndex) Copies the elements of this collection into an array at a specified position.
protected java.lang.Character	toObject(char value) Wraps an char with an Object wrapper.
protected char	toPrimitive(java.lang.Object value) Unwraps the Character to retrieve the primitive char.
protected char[]	toPrimitiveArray(java.util.Collection<?> coll) Unwraps a Collection to retrieve the primitive char.
java.lang.String	toString() Gets a string representing this collection.

Methods inherited from class org.joda.primitives.collection.impl.AbstractPrimitiveCollectable

clone, isEmpty, optimize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.joda.primitives.collection.CharCollection

iterator

Methods inherited from interface org.joda.primitives.PrimitiveCollectable

clone, isEmpty, optimize, size

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty, parallelStream, removeIf, size, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

AbstractCharCollection

protected AbstractCharCollection()

Constructor.

Method Detail

contains

public boolean contains(char value)

Checks whether this collection contains a specified primitive value.

This implementation uses charIterator().

Specified by:

contains in interface CharCollection

Parameters:

value - the value to search for

Returns:

true if the value is found

containsAll

public boolean containsAll(char[] values)

Checks if this collection contains all of the values in the specified array. If the specified array is empty, true is returned.

This implementation uses contains(char).

Specified by:

containsAll in interface CharCollection

Parameters:

values - the values to search for, null treated as empty array

Returns:

true if all of the values are found

containsAll

public boolean containsAll(CharCollection values)

Checks if this collection contains all of the values in the specified collection. If the specified collection is empty, true is returned.

This implementation uses contains(char).

Specified by:

containsAll in interface CharCollection

Parameters:

values - the values to search for, null treated as empty collection

Returns:

true if all of the values are found

containsAll

public boolean containsAll(char startInclusive,
                           char endInclusive)

Checks if this collection contain all the values in the specified range.

The range is defined to be inclusive of the start and end. If the start is greater than the end then the result is true as the range is equivalent to an empty collection.

This implementation uses contains(char).

Specified by:

containsAll in interface CharCollection

Parameters:

startInclusive - the inclusive range start value

endInclusive - the inclusive range end value

Returns:

true if the collection contains the entire range

containsAny

public boolean containsAny(char[] values)

Checks if this collection contains any of the values in the specified array. If the specified array is empty, false is returned.

This implementation uses contains(char).

Specified by:

containsAny in interface CharCollection

Parameters:

values - the values to search for, null treated as empty array

Returns:

true if at least one of the values is found

containsAny

public boolean containsAny(CharCollection values)

Checks if this collection contains any of the values in the specified collection. If the specified collection is empty, false is returned.

This implementation uses contains(char).

Specified by:

containsAny in interface CharCollection

Parameters:

values - the values to search for, null treated as empty collection

Returns:

true if at least one of the values is found

containsAny

public boolean containsAny(char startInclusive,
                           char endInclusive)

Checks if this collection contain some of the values in the specified range.

The range is defined to be inclusive of the start and end. If the start is greater than the end then the result is false as the range is equivalent to an empty collection.

This implementation uses contains(char).

Specified by:

containsAny in interface CharCollection

Parameters:

startInclusive - the inclusive range start value

endInclusive - the inclusive range end value

Returns:

true if the collection contains at least one of the range

toCharArray

public char[] toCharArray()

Gets the elements of this collection as an array.

This implementation uses arrayCopy.

Specified by:

toCharArray in interface CharCollection

Returns:

a new array containing a copy of the elements of this collection

toCharArray

public char[] toCharArray(char[] array,
                          int startIndex)

Copies the elements of this collection into an array at a specified position. Previous values in the array are overwritten.

If the array specified is null a new array is created. If the array specified is large enough, it will be modified. If the array is not large enough, a new array will be created containing the values from the specified array before the startIndex plus those from this collection.

This implementation uses arrayCopy.

Specified by:

toCharArray in interface CharCollection

Parameters:

array - the array to add the elements to, null treated as empty array

startIndex - the position in the array to start setting elements

Returns:

the array with the populated collection

Throws:

java.lang.IndexOutOfBoundsException - if the index is negative

clear

public void clear()

Clears the collection/map of all elements (optional operation).

The collection/map will have a zero size after this method completes. This method is optional, throwing an UnsupportedOperationException if the collection/map cannot be cleared.

This implementation uses iterator().

Specified by:

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

Specified by:

clear in interface PrimitiveCollectable<java.lang.Character>

Throws:

java.lang.UnsupportedOperationException - if method not supported by this collection

add

public boolean add(char value)

Adds a primitive value to this collection (optional operation).

This implementation throws UnsupportedOperationException.

Specified by:

add in interface CharCollection

Parameters:

value - the value to add to this collection

Returns:

true if this collection was modified by this method call

Throws:

java.lang.IllegalArgumentException - if value is rejected by this collection

java.lang.UnsupportedOperationException - if not supported by this collection

addAll

public boolean addAll(char[] values)

Adds an array of primitive values to this collection (optional operation).

This implementation uses add(char).

Specified by:

addAll in interface CharCollection

Parameters:

values - the values to add to this collection, null treated as empty array

Returns:

true if this collection was modified by this method call

Throws:

java.lang.IllegalArgumentException - if a value is rejected by this collection

java.lang.UnsupportedOperationException - if not supported by this collection

addAll

public boolean addAll(CharCollection values)

Adds a collection of primitive values to this collection (optional operation).

This implementation uses add(char).

Specified by:

addAll in interface CharCollection

Parameters:

values - the values to add to this collection, null treated as empty collection

Returns:

true if this collection was modified by this method call

Throws:

java.lang.IllegalArgumentException - if a value is rejected by this collection

java.lang.UnsupportedOperationException - if not supported by this collection

addAll

public boolean addAll(char startInclusive,
                      char endInclusive)

Adds a range of primitive values to this collection (optional operation).

The range is defined to be inclusive of the start and end. If the start is greater than the end then the range is equivalent to an empty collection.

This implementation uses add(char).

Specified by:

addAll in interface CharCollection

Parameters:

startInclusive - the inclusive range start value

endInclusive - the inclusive range end value

Returns:

true if this collection was modified by this method call

Throws:

java.lang.IllegalArgumentException - if a value is rejected by this set

java.lang.UnsupportedOperationException - if not supported by this set

removeFirst

public boolean removeFirst(char value)

Removes the first occurrence of the specified primitive value from this collection

This implementation uses iterator().remove().

Specified by:

removeFirst in interface CharCollection

Parameters:

value - the value to remove

Returns:

true if this collection was modified by this method call

Throws:

java.lang.UnsupportedOperationException - if not supported by this collection

removeAll

public boolean removeAll(char value)

Removes all occurrences of the specified primitive value from this collection.

This implementation uses iterator().remove().

Specified by:

removeAll in interface CharCollection

Parameters:

value - the value to remove

Returns:

true if this collection was modified by this method call

Throws:

java.lang.UnsupportedOperationException - if not supported by this collection

removeAll

public boolean removeAll(char[] values)

Removes all occurrences from this collection of each primitive in the specified array.

This implementation uses iterator().remove().

Specified by:

removeAll in interface CharCollection

Parameters:

values - the values to remove from this collection, null treated as empty array

Returns:

true if this list was modified by this method call

Throws:

java.lang.UnsupportedOperationException - if not supported by this collection

removeAll

public boolean removeAll(CharCollection values)

Removes all occurrences from this collection of each primitive in the specified collection.

This implementation uses iterator().remove().

Specified by:

removeAll in interface CharCollection

Parameters:

values - the values to remove from this collection, null treated as empty collection

Returns:

true if this list was modified by this method call

Throws:

java.lang.UnsupportedOperationException - if not supported by this collection

removeAll

public boolean removeAll(char startInclusive,
                         char endInclusive)

Removes all occurrences of a range of primitive values from this collection.

The range is defined to be inclusive of the start and end. The elements removed are greater than or equal to the start and less than or equal to the end. Thus if the start is greater than the end then no elements are removed.

This method is optional, throwing an UnsupportedOperationException if the set cannot be changed.

This implementation uses iterator().remove().

Specified by:

removeAll in interface CharCollection

Parameters:

startInclusive - the inclusive range start value

endInclusive - the inclusive range end value

Returns:

true if this collection was modified by this method call

Throws:

java.lang.UnsupportedOperationException - if not supported by this collection

retainAll

public boolean retainAll(char[] values)

Retains each element of this collection that is present in the specified array removing all other values.

This implementation uses iterator().remove().

Specified by:

retainAll in interface CharCollection

Parameters:

values - the values to remove from this collection, null treated as empty array

Returns:

true if this list was modified by this method call

Throws:

java.lang.UnsupportedOperationException - if not supported by this collection

retainAll

public boolean retainAll(CharCollection values)

Retains each element of this collection that is present in the specified collection removing all other values.

This implementation uses iterator().remove().

Specified by:

retainAll in interface CharCollection

Parameters:

values - the values to retain in this collection, null treated as empty collection

Returns:

true if this collection was modified by this method call

Throws:

java.lang.UnsupportedOperationException - if not supported by this collection

retainAll

public boolean retainAll(char startInclusive,
                         char endInclusive)

Retains all occurences of a range of primitive values within this collection removing all values outside the range (optional operation).

The range is defined to be inclusive of the start and end. If the start is greater than the end then the range is equivalent to an empty collection.

This method is optional, throwing an UnsupportedOperationException if the set cannot be changed.

Specified by:

retainAll in interface CharCollection

Parameters:

startInclusive - the inclusive range start value

endInclusive - the inclusive range end value

Returns:

true if this collection was modified by this method call

Throws:

java.lang.UnsupportedOperationException - if not supported by this collection

contains

public boolean contains(java.lang.Object value)

Checks whether this collection contains a specified Character value.

This implementation uses contains(char).

Specified by:

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

Parameters:

value - the value to search for

Returns:

true if the value is found

containsAll

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

Checks if the collection contains all of the primitive values.

This implementation uses containsAll(char[]).

Specified by:

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

Parameters:

coll - the collection of values to search for

Returns:

true if all the values are found

containsAny

public boolean containsAny(java.util.Collection<?> coll)

Checks if the collection contains any of the primitive values in the array. If the specified collection is empty, false is returned.

This implementation uses containsAny(char[]).

Specified by:

containsAny in interface PrimitiveCollection<java.lang.Character>

Parameters:

coll - the collection of values to search for

Returns:

true if at least one of the values is found

toArray

public java.lang.Object[] toArray()

Gets the collection as an array of Character.

Specified by:

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

Returns:

an array of Character

toArray

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

Gets the collection as an array, using the array provided.

Specified by:

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

Type Parameters:

T - the array type

Parameters:

array - the array to populate

Returns:

an array of Character

add

public boolean add(java.lang.Character value)

Adds the Character value to this collection (optional operation).

This method is optional, throwing an UnsupportedOperationException if the collection cannot be added to.

This implementation uses add(char).

Specified by:

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

Parameters:

value - the value to add to this collection

Returns:

true if this collection was modified by this method call

Throws:

java.lang.IllegalArgumentException - if value is rejected by this collection

java.lang.UnsupportedOperationException - if not supported by this collection

addAll

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

Adds a collection of Character values to this collection (optional operation).

This method is optional, throwing an UnsupportedOperationException if the collection cannot be added to.

This implementation uses addAll(char[]).

Specified by:

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

Parameters:

coll - the values to add to this collection

Returns:

true if this list was modified by this method call

Throws:

java.lang.IndexOutOfBoundsException - if the index is invalid

java.lang.ClassCastException - if any object is not Character

java.lang.IllegalArgumentException - if value is rejected by this collection

java.lang.UnsupportedOperationException - if not supported by this collection

remove

public boolean remove(java.lang.Object value)

Removes the first occurrance of the specified Character value from this collection (optional operation).

This method is optional, throwing an UnsupportedOperationException if the collection cannot be removed from.

This implementation uses removeFirst(char).

Specified by:

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

Parameters:

value - the value to remove

Returns:

true if this collection was modified by this method call

Throws:

java.lang.UnsupportedOperationException - if not supported by this collection

removeAll

public boolean removeAll(java.util.Collection<?> coll)

Removes each of a collection of Character values from this collection (optional operation).

This method is optional, throwing an UnsupportedOperationException if the collection cannot be added to.

This implementation uses removeAll(char[]).

Specified by:

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

Parameters:

coll - the values to remove from this collection

Returns:

true if this list was modified by this method call

Throws:

java.lang.UnsupportedOperationException - if not supported by this collection

retainAll

public boolean retainAll(java.util.Collection<?> coll)

Retains each of a collection of Character values, removing other values (optional operation).

This method is optional, throwing an UnsupportedOperationException if the collection cannot be added to.

This implementation uses retainAll(char[]).

Specified by:

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

Parameters:

coll - the values to retain in this collection

Returns:

true if this list was modified by this method call

Throws:

java.lang.UnsupportedOperationException - if not supported by this collection

toString

public java.lang.String toString()

Gets a string representing this collection.

The format used is as per Collection.

Overrides:

toString in class java.lang.Object

Returns:

collection as a String

arrayCopy

protected void arrayCopy(int fromIndex,
                         char[] dest,
                         int destIndex,
                         int size)

Copies data from this collection into the specified array. This method is pre-validated.

Parameters:

fromIndex - the index to start from

dest - the destination array

destIndex - the destination start index

size - the number of items to copy

isAddModifiable

protected boolean isAddModifiable()

Are the add methods supported.

This implementation returns false.

Returns:

true if supported

isRemoveModifiable

protected boolean isRemoveModifiable()

Are the remove methods supported.

This implementation returns false.

Returns:

true if supported

isModifiable

public boolean isModifiable()

Is the collection modifiable in any way.

Specified by:

isModifiable in interface PrimitiveCollectable<java.lang.Character>

Overrides:

isModifiable in class AbstractPrimitiveCollectable<java.lang.Character>

Returns:

true if supported

checkAddModifiable

protected void checkAddModifiable()

Check whether add is suported and throw an exception.

checkRemoveModifiable

protected void checkRemoveModifiable()

Check whether remove is suported and throw an exception.

toObject

protected java.lang.Character toObject(char value)

Wraps an char with an Object wrapper.

Parameters:

value - the primitive value

Returns:

the Object wrapper

isToPrimitivePossible

protected boolean isToPrimitivePossible(java.lang.Object value)

Checks if the object can be converted to a primitive successfully.

This implementation only allows non-null Char objects.

Parameters:

value - the Object wrapper

Returns:

true if a primitive value can be successfully extracted

toPrimitive

protected char toPrimitive(java.lang.Object value)

Unwraps the Character to retrieve the primitive char.

This implementation only allows non-null Char objects.

Parameters:

value - the Object to convert to a primitive

Returns:

the primitive value

Throws:

java.lang.NullPointerException - if the value is null and this is unacceptable

java.lang.ClassCastException - if the object is of an unsuitable type

toPrimitiveArray

protected char[] toPrimitiveArray(java.util.Collection<?> coll)

Unwraps a Collection to retrieve the primitive char.

This implementation only allows non-null Char objects.

Parameters:

coll - the Collection to convert to primitives

Returns:

the primitive value

Throws:

java.lang.NullPointerException - if the value is null and this is unacceptable

java.lang.ClassCastException - if any object is of an unsuitable type