Package org.eclipse.collections.impl.map.mutable.primitive

Class AbstractMutableCharKeySet

java.lang.Object

org.eclipse.collections.impl.map.mutable.primitive.AbstractMutableCharKeySet

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, CharIterable, MutableCharCollection, PrimitiveIterable, CharSet, MutableCharSet

Direct Known Subclasses:

CharBooleanHashMap.KeySet, CharByteHashMap.KeySet, CharCharHashMap.KeySet, CharDoubleHashMap.KeySet, CharFloatHashMap.KeySet, CharIntHashMap.KeySet, CharLongHashMap.KeySet, CharObjectHashMap.KeySet, CharShortHashMap.KeySet

public abstract class AbstractMutableCharKeySet
extends java.lang.Object
implements MutableCharSet, java.io.Externalizable

This file was automatically generated from template file abstractMutablePrimitiveKeySet.stg.

Since:

6.0.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	AbstractMutableCharKeySet.SerRep

Field Summary

Fields

Modifier and Type	Field	Description
private static char	EMPTY_KEY
private static char	REMOVED_KEY
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
AbstractMutableCharKeySet()

Method Summary

Modifier and Type	Method	Description
boolean	add(char element)
boolean	addAll(char... source)
boolean	addAll(CharIterable source)
boolean	allSatisfy(CharPredicate predicate)	Returns true if all of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
boolean	anySatisfy(CharPredicate predicate)	Returns true if any of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
void	appendString(java.lang.Appendable appendable)	Prints a string representation of this collection onto the given Appendable.
void	appendString(java.lang.Appendable appendable, java.lang.String separator)	Prints a string representation of this collection onto the given Appendable.
void	appendString(java.lang.Appendable appendable, java.lang.String start, java.lang.String separator, java.lang.String end)	Prints a string representation of this collection onto the given Appendable.
LazyCharIterable	asLazy()	Returns a LazyCharIterable adapter wrapping the source CharIterable.
MutableCharSet	asSynchronized()
MutableCharSet	asUnmodifiable()
double	average()
MutableSet<java.lang.Character>	boxed()
LazyIterable<CharCharPair>	cartesianProduct(CharSet set)	Returns the set whose members are all possible ordered pairs (a, b) where a is a member of this and b is a member of set.
RichIterable<CharIterable>	chunk(int size)	Partitions elements in fixed size chunks.
void	clear()
<V> MutableSet<V>	collect(CharToObjectFunction<? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
boolean	contains(char value)	Returns true if the value is contained in the CharIterable, and false if it is not.
boolean	containsAll(char... source)	Returns true if all of the values specified in the source array are contained in the CharIterable, and false if they are not.
boolean	containsAll(CharIterable source)	Returns true if all of the values specified in the source CharIterable are contained in the CharIterable, and false if they are not.
int	count(CharPredicate predicate)	Returns a count of the number of elements in the CharIterable that return true for the specified predicate.
char	detectIfNone(CharPredicate predicate, char ifNone)
void	each(CharProcedure procedure)	A synonym for forEach.
boolean	equals(java.lang.Object obj)	Follows the same general contract as Set.equals(Object).
protected abstract char	getKeyAtIndex(int index)
protected abstract MutableCharKeysMap	getOuter()
protected abstract AbstractSentinelValues	getSentinelValues()
protected abstract int	getTableSize()
int	hashCode()	Follows the same general contract as Set.hashCode().
<T> T	injectInto(T injectedValue, ObjectCharToObjectFunction<? super T,? extends T> function)
boolean	isEmpty()	Returns true if this iterable has zero items.
private static boolean	isEmptyKey(char key)
private static boolean	isNonSentinel(char key)
private static boolean	isRemovedKey(char key)
java.lang.String	makeString()	Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
java.lang.String	makeString(java.lang.String separator)	Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
java.lang.String	makeString(java.lang.String start, java.lang.String separator, java.lang.String end)	Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.
char	max()
char	maxIfEmpty(char defaultValue)
double	median()
char	min()
char	minIfEmpty(char defaultValue)
boolean	notEmpty()	The English equivalent of !this.isEmpty()
void	readExternal(java.io.ObjectInput in)
MutableCharSet	reject(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
boolean	remove(char key)
boolean	removeAll(char... source)
boolean	removeAll(CharIterable source)
MutableCharSet	select(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.
int	size()	Returns the number of items in this iterable.
long	sum()
char[]	toArray()	Converts the CharIterable to a primitive char array.
char[]	toArray(char[] result)	Converts the CharIterable to a primitive char array.
MutableCharBag	toBag()	Converts the CharIterable to a new MutableCharBag.
ImmutableCharSet	toImmutable()	Returns an immutable copy of this set.
MutableCharList	toList()	Converts the CharIterable to a new MutableCharList.
MutableCharSet	toSet()	Converts the CharIterable to a new MutableCharSet.
char[]	toSortedArray()
MutableCharList	toSortedList()
java.lang.String	toString()	Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.
MutableCharSet	with(char element)
MutableCharSet	withAll(CharIterable elements)
MutableCharSet	without(char element)
MutableCharSet	withoutAll(CharIterable elements)
void	writeExternal(java.io.ObjectOutput out)
java.lang.Object	writeReplace()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.collections.api.CharIterable

averageIfEmpty, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAny, containsAny, containsNone, containsNone, flatCollect, forEach, injectIntoBoolean, injectIntoByte, injectIntoChar, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, injectIntoShort, medianIfEmpty, noneSatisfy, reduce, reduceIfEmpty, reject, select, summaryStatistics, toSortedList, toSortedListBy, toSortedListBy

Methods inherited from interface org.eclipse.collections.api.set.primitive.CharSet

isProperSubsetOf, isSubsetOf

Methods inherited from interface org.eclipse.collections.api.collection.primitive.MutableCharCollection

charIterator, removeIf, retainAll, retainAll

Methods inherited from interface org.eclipse.collections.api.set.primitive.MutableCharSet

difference, freeze, intersect, newEmpty, symmetricDifference, tap, union

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

EMPTY_KEY

private static final char EMPTY_KEY

See Also:

Constant Field Values

REMOVED_KEY

private static final char REMOVED_KEY

See Also:

Constant Field Values

Constructor Detail

AbstractMutableCharKeySet

public AbstractMutableCharKeySet()

Method Detail

isEmptyKey

private static boolean isEmptyKey(char key)

isRemovedKey

private static boolean isRemovedKey(char key)

isNonSentinel

private static boolean isNonSentinel(char key)

boxed

public MutableSet<java.lang.Character> boxed()

Specified by:

boxed in interface MutableCharSet

getKeyAtIndex

protected abstract char getKeyAtIndex(int index)

getTableSize

protected abstract int getTableSize()

getOuter

protected abstract MutableCharKeysMap getOuter()

getSentinelValues

protected abstract AbstractSentinelValues getSentinelValues()

each

public void each(CharProcedure procedure)

Description copied from interface: CharIterable

A synonym for forEach.

Specified by:

each in interface CharIterable

Since:

7.0.

count

public int count(CharPredicate predicate)

Description copied from interface: CharIterable

Returns a count of the number of elements in the CharIterable that return true for the specified predicate.

Specified by:

count in interface CharIterable

anySatisfy

public boolean anySatisfy(CharPredicate predicate)

Description copied from interface: CharIterable

Returns true if any of the elements in the CharIterable return true for the specified predicate, otherwise returns false.

Specified by:

anySatisfy in interface CharIterable

allSatisfy

public boolean allSatisfy(CharPredicate predicate)

Description copied from interface: CharIterable

Returns true if all of the elements in the CharIterable return true for the specified predicate, otherwise returns false.

Specified by:

allSatisfy in interface CharIterable

add

public boolean add(char element)

Specified by:

add in interface MutableCharCollection

addAll

public boolean addAll(char... source)

Specified by:

addAll in interface MutableCharCollection

addAll

public boolean addAll(CharIterable source)

Specified by:

addAll in interface MutableCharCollection

select

public MutableCharSet select(CharPredicate predicate)

Description copied from interface: CharIterable

Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.

Specified by:

select in interface CharIterable

Specified by:

select in interface CharSet

Specified by:

select in interface MutableCharCollection

Specified by:

select in interface MutableCharSet

reject

public MutableCharSet reject(CharPredicate predicate)

Description copied from interface: CharIterable

Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.

Specified by:

reject in interface CharIterable

Specified by:

reject in interface CharSet

Specified by:

reject in interface MutableCharCollection

Specified by:

reject in interface MutableCharSet

with

public MutableCharSet with(char element)

Specified by:

with in interface MutableCharCollection

Specified by:

with in interface MutableCharSet

without

public MutableCharSet without(char element)

Specified by:

without in interface MutableCharCollection

Specified by:

without in interface MutableCharSet

withAll

public MutableCharSet withAll(CharIterable elements)

Specified by:

withAll in interface MutableCharCollection

Specified by:

withAll in interface MutableCharSet

withoutAll

public MutableCharSet withoutAll(CharIterable elements)

Specified by:

withoutAll in interface MutableCharCollection

Specified by:

withoutAll in interface MutableCharSet

collect

public <V> MutableSet<V> collect(CharToObjectFunction<? extends V> function)

Description copied from interface: CharIterable

Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Specified by:

collect in interface CharIterable

Specified by:

collect in interface CharSet

Specified by:

collect in interface MutableCharCollection

Specified by:

collect in interface MutableCharSet

remove

public boolean remove(char key)

Specified by:

remove in interface MutableCharCollection

removeAll

public boolean removeAll(CharIterable source)

Specified by:

removeAll in interface MutableCharCollection

removeAll

public boolean removeAll(char... source)

Specified by:

removeAll in interface MutableCharCollection

clear

public void clear()

Specified by:

clear in interface MutableCharCollection

detectIfNone

public char detectIfNone(CharPredicate predicate,
                         char ifNone)

Specified by:

detectIfNone in interface CharIterable

asUnmodifiable

public MutableCharSet asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableCharCollection

Specified by:

asUnmodifiable in interface MutableCharSet

asSynchronized

public MutableCharSet asSynchronized()

Specified by:

asSynchronized in interface MutableCharCollection

Specified by:

asSynchronized in interface MutableCharSet

sum

public long sum()

Specified by:

sum in interface CharIterable

max

public char max()

Specified by:

max in interface CharIterable

maxIfEmpty

public char maxIfEmpty(char defaultValue)

Specified by:

maxIfEmpty in interface CharIterable

min

public char min()

Specified by:

min in interface CharIterable

minIfEmpty

public char minIfEmpty(char defaultValue)

Specified by:

minIfEmpty in interface CharIterable

average

public double average()

Specified by:

average in interface CharIterable

median

public double median()

Specified by:

median in interface CharIterable

toSortedArray

public char[] toSortedArray()

Specified by:

toSortedArray in interface CharIterable

toSortedList

public MutableCharList toSortedList()

Specified by:

toSortedList in interface CharIterable

toArray

public char[] toArray()

Description copied from interface: CharIterable

Converts the CharIterable to a primitive char array.

Specified by:

toArray in interface CharIterable

toArray

public char[] toArray(char[] result)

Description copied from interface: CharIterable

Converts the CharIterable to a primitive char array. If the collection fits into the provided array it is used to store its elements and is returned from the method, otherwise a new array of the appropriate size is allocated and returned. If the iterable is empty, the target array is returned unchanged.

Specified by:

toArray in interface CharIterable

contains

public boolean contains(char value)

Description copied from interface: CharIterable

Returns true if the value is contained in the CharIterable, and false if it is not.

Specified by:

contains in interface CharIterable

containsAll

public boolean containsAll(char... source)

Description copied from interface: CharIterable

Returns true if all of the values specified in the source array are contained in the CharIterable, and false if they are not.

Specified by:

containsAll in interface CharIterable

containsAll

public boolean containsAll(CharIterable source)

Description copied from interface: CharIterable

Returns true if all of the values specified in the source CharIterable are contained in the CharIterable, and false if they are not.

Specified by:

containsAll in interface CharIterable

cartesianProduct

public LazyIterable<CharCharPair> cartesianProduct(CharSet set)

Description copied from interface: CharSet

Returns the set whose members are all possible ordered pairs (a, b) where a is a member of this and b is a member of set.

Specified by:

cartesianProduct in interface CharSet

toList

public MutableCharList toList()

Description copied from interface: CharIterable

Converts the CharIterable to a new MutableCharList.

Specified by:

toList in interface CharIterable

toSet

public MutableCharSet toSet()

Description copied from interface: CharIterable

Converts the CharIterable to a new MutableCharSet.

Specified by:

toSet in interface CharIterable

toBag

public MutableCharBag toBag()

Description copied from interface: CharIterable

Converts the CharIterable to a new MutableCharBag.

Specified by:

toBag in interface CharIterable

asLazy

public LazyCharIterable asLazy()

Description copied from interface: CharIterable

Returns a LazyCharIterable adapter wrapping the source CharIterable.

Specified by:

asLazy in interface CharIterable

injectInto

public <T> T injectInto(T injectedValue,
                        ObjectCharToObjectFunction<? super T,? extends T> function)

Specified by:

injectInto in interface CharIterable

toImmutable

public ImmutableCharSet toImmutable()

Description copied from interface: MutableCharSet

Returns an immutable copy of this set.

Specified by:

toImmutable in interface CharSet

Specified by:

toImmutable in interface MutableCharCollection

Specified by:

toImmutable in interface MutableCharSet

size

public int size()

Description copied from interface: PrimitiveIterable

Returns the number of items in this iterable.

Specified by:

size in interface PrimitiveIterable

isEmpty

public boolean isEmpty()

Description copied from interface: PrimitiveIterable

Returns true if this iterable has zero items.

Specified by:

isEmpty in interface PrimitiveIterable

notEmpty

public boolean notEmpty()

Description copied from interface: PrimitiveIterable

The English equivalent of !this.isEmpty()

Specified by:

notEmpty in interface PrimitiveIterable

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: CharSet

Follows the same general contract as Set.equals(Object).

Specified by:

equals in interface CharSet

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Description copied from interface: CharSet

Follows the same general contract as Set.hashCode().

Specified by:

hashCode in interface CharSet

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Description copied from interface: PrimitiveIterable

Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.

 Assert.assertEquals("[]", IntLists.mutable.empty().toString());
 Assert.assertEquals("[1]", IntLists.mutable.with(1).toString());
 Assert.assertEquals("[1, 2, 3]", IntLists.mutable.with(1, 2, 3).toString());
 

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this PrimitiveIterable

See Also:

AbstractCollection.toString()

makeString

public java.lang.String makeString()

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

makeString

public java.lang.String makeString(java.lang.String separator)

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

makeString

public java.lang.String makeString(java.lang.String start,
                                   java.lang.String separator,
                                   java.lang.String end)

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

appendString

public void appendString(java.lang.Appendable appendable)

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString().

Specified by:

appendString in interface PrimitiveIterable

appendString

public void appendString(java.lang.Appendable appendable,
                         java.lang.String separator)

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String).

Specified by:

appendString in interface PrimitiveIterable

appendString

public void appendString(java.lang.Appendable appendable,
                         java.lang.String start,
                         java.lang.String separator,
                         java.lang.String end)

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String, String, String).

Specified by:

appendString in interface PrimitiveIterable

chunk

public RichIterable<CharIterable> chunk(int size)

Description copied from interface: CharIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface CharIterable

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing CharIterables of size size, except the last will be truncated if the elements don't divide evenly.

writeReplace

public java.lang.Object writeReplace()
                              throws java.io.ObjectStreamException

Throws:

java.io.ObjectStreamException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException