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

Class ImmutableCharCharHashMap

java.lang.Object

org.eclipse.collections.impl.map.immutable.primitive.ImmutableCharCharHashMap

All Implemented Interfaces:

java.io.Serializable, CharIterable, CharCharMap, CharValuesMap, ImmutableCharCharMap, PrimitiveIterable

final class ImmutableCharCharHashMap
extends java.lang.Object
implements ImmutableCharCharMap, java.io.Serializable

ImmutableCharCharHashMap is the non-modifiable equivalent of CharCharHashMap. This file was automatically generated from template file immutablePrimitivePrimitiveHashMap.stg.

Since:

4.0.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ImmutableCharCharHashMap.ImmutableCharCharMapSerializationProxy

Field Summary

Fields

Modifier and Type	Field	Description
private MutableCharCharMap	delegate
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
ImmutableCharCharHashMap(CharCharMap delegate)

Method Summary

Modifier and Type	Method	Description
boolean	allSatisfy(CharPredicate predicate)	Returns true if all of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
boolean	allSatisfyKeyValue(CharCharPredicate predicate)
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.
double	average()
CharIterator	charIterator()	Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.
RichIterable<CharIterable>	chunk(int size)	Partitions elements in fixed size chunks.
<V> ImmutableBag<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.
boolean	containsKey(char key)	Returns whether or not the key is present in the map.
boolean	containsValue(char value)	Returns whether or not this map contains the value.
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 Map.equals(Object).
ImmutableCharCharMap	flipUniqueValues()	Return the CharCharMap that is obtained by flipping the direction of this map and making the associations from value to key.
void	forEachKey(CharProcedure procedure)	Iterates through each key in the map, invoking the procedure for each.
void	forEachKeyValue(CharCharProcedure procedure)	Iterates through each key/value pair in the map, invoking the procedure for each.
void	forEachValue(CharProcedure procedure)	Iterates through each value in this map.
char	get(char key)	Retrieves the value associated with the key.
char	getIfAbsent(char key, char ifAbsent)	Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
char	getOrThrow(char key)	Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.
int	hashCode()	Follows the same general contract as Map.hashCode().
<T> T	injectInto(T injectedValue, ObjectCharToObjectFunction<? super T,? extends T> function)
boolean	isEmpty()	Returns true if this iterable has zero items.
MutableCharSet	keySet()	Returns a set containing all the keys in this map.
LazyCharIterable	keysView()	Returns a view of the keys in this map.
RichIterable<CharCharPair>	keyValuesView()	Returns a view of the key/value pairs in this map.
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)
ImmutableCharCharMap	newWithKeyValue(char key, char value)	Copy this map, associate the value with the key (replacing the value if one already exists for key), and return the copy as new immutable map.
ImmutableCharCharMap	newWithoutAllKeys(CharIterable keys)	Copy this map, remove any associated values with the specified keys (if any exist), and return the copy as a new immutable map.
ImmutableCharCharMap	newWithoutKey(char key)	Copy this map, remove any associated value with the key (if one exists), and return the copy as a new immutable map.
boolean	noneSatisfy(CharPredicate predicate)	Returns true if none of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
boolean	notEmpty()	The English equivalent of !this.isEmpty()
ImmutableCharCharMap	reject(CharCharPredicate predicate)	Return a copy of this map containing only the key/value pairs that do not match the predicate.
ImmutableCharBag	reject(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
ImmutableCharCharMap	select(CharCharPredicate predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
ImmutableCharBag	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[] target)	Converts the CharIterable to a primitive char array.
MutableCharBag	toBag()	Converts the CharIterable to a new MutableCharBag.
ImmutableCharCharMap	toImmutable()	Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.
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()	Follows the same general contract as AbstractMap.toString()
MutableCharCollection	values()	Returns the values in this map as a separate collection.
private 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.map.primitive.CharCharMap

injectIntoKeyValue

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, reduce, reduceIfEmpty, reject, select, summaryStatistics, toSortedList, toSortedListBy, toSortedListBy

Methods inherited from interface org.eclipse.collections.api.map.primitive.CharValuesMap

tap

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

delegate

private final MutableCharCharMap delegate

Constructor Detail

ImmutableCharCharHashMap

ImmutableCharCharHashMap(CharCharMap delegate)

Method Detail

get

public char get(char key)

Description copied from interface: CharCharMap

Retrieves the value associated with the key. If no mapping exists for the key, the default value (usually 0) is returned.

Specified by:

get in interface CharCharMap

Parameters:

key - the key

Returns:

the value associated with the key, or the default value if no such mapping exists

getIfAbsent

public char getIfAbsent(char key,
                        char ifAbsent)

Description copied from interface: CharCharMap

Retrieves the value associated with the key, returning the specified default value if no such mapping exists.

Specified by:

getIfAbsent in interface CharCharMap

Parameters:

key - the key

ifAbsent - the default value to return if no mapping exists for key

Returns:

the value associated with the key, or ifAbsent if no such mapping exists.

getOrThrow

public char getOrThrow(char key)

Description copied from interface: CharCharMap

Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.

Specified by:

getOrThrow in interface CharCharMap

Parameters:

key - the key

Returns:

the value associated with the key

containsKey

public boolean containsKey(char key)

Description copied from interface: CharCharMap

Returns whether or not the key is present in the map.

Specified by:

containsKey in interface CharCharMap

Parameters:

key - the key

Returns:

if a mapping exists in this map for the key

containsValue

public boolean containsValue(char value)

Description copied from interface: CharValuesMap

Returns whether or not this map contains the value.

Specified by:

containsValue in interface CharValuesMap

Parameters:

value - the value to test

Returns:

if this collection contains the value

forEachValue

public void forEachValue(CharProcedure procedure)

Description copied from interface: CharValuesMap

Iterates through each value in this map.

Specified by:

forEachValue in interface CharValuesMap

Parameters:

procedure - the procedure to invoke for each value in this map.

forEachKey

public void forEachKey(CharProcedure procedure)

Description copied from interface: CharCharMap

Iterates through each key in the map, invoking the procedure for each.

Specified by:

forEachKey in interface CharCharMap

Parameters:

procedure - the procedure to invoke for each key

forEachKeyValue

public void forEachKeyValue(CharCharProcedure procedure)

Description copied from interface: CharCharMap

Iterates through each key/value pair in the map, invoking the procedure for each.

Specified by:

forEachKeyValue in interface CharCharMap

Parameters:

procedure - the procedure to invoke for each key/value pair

allSatisfyKeyValue

public boolean allSatisfyKeyValue(CharCharPredicate predicate)

Specified by:

allSatisfyKeyValue in interface CharCharMap

Since:

12.0

keysView

public LazyCharIterable keysView()

Description copied from interface: CharCharMap

Returns a view of the keys in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the keys returned by the iterable.

Specified by:

keysView in interface CharCharMap

Returns:

a view of the keys in this map

keyValuesView

public RichIterable<CharCharPair> keyValuesView()

Description copied from interface: CharCharMap

Returns a view of the key/value pairs in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the pairs returned by the iterable.

Specified by:

keyValuesView in interface CharCharMap

Returns:

a view of the keys in this map

flipUniqueValues

public ImmutableCharCharMap flipUniqueValues()

Description copied from interface: CharCharMap

Return the CharCharMap that is obtained by flipping the direction of this map and making the associations from value to key.

Specified by:

flipUniqueValues in interface CharCharMap

Specified by:

flipUniqueValues in interface ImmutableCharCharMap

select

public ImmutableCharCharMap select(CharCharPredicate predicate)

Description copied from interface: CharCharMap

Return a copy of this map containing only the key/value pairs that match the predicate.

Specified by:

select in interface CharCharMap

Specified by:

select in interface ImmutableCharCharMap

Parameters:

predicate - the predicate to determine which key/value pairs in this map should be included in the returned map

Returns:

a copy of this map with the matching key/value pairs

reject

public ImmutableCharCharMap reject(CharCharPredicate predicate)

Description copied from interface: CharCharMap

Return a copy of this map containing only the key/value pairs that do not match the predicate.

Specified by:

reject in interface CharCharMap

Specified by:

reject in interface ImmutableCharCharMap

Parameters:

predicate - the predicate to determine which key/value pairs in this map should be excluded from the returned map

Returns:

a copy of this map without the matching key/value pairs

injectInto

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

Specified by:

injectInto in interface CharIterable

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.

toImmutable

public ImmutableCharCharMap toImmutable()

Description copied from interface: CharCharMap

Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.

Specified by:

toImmutable in interface CharCharMap

Returns:

an immutable map that is equivalent to this one

charIterator

public CharIterator charIterator()

Description copied from interface: CharIterable

Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.

Specified by:

charIterator in interface CharIterable

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

noneSatisfy

public boolean noneSatisfy(CharPredicate predicate)

Description copied from interface: CharIterable

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

Specified by:

noneSatisfy in interface CharIterable

select

public ImmutableCharBag 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 CharValuesMap

Specified by:

select in interface ImmutableCharCharMap

reject

public ImmutableCharBag 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 CharValuesMap

Specified by:

reject in interface ImmutableCharCharMap

collect

public <V> ImmutableBag<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 CharValuesMap

Specified by:

collect in interface ImmutableCharCharMap

detectIfNone

public char detectIfNone(CharPredicate predicate,
                         char ifNone)

Specified by:

detectIfNone in interface CharIterable

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

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

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

newWithKeyValue

public ImmutableCharCharMap newWithKeyValue(char key,
                                            char value)

Description copied from interface: ImmutableCharCharMap

Copy this map, associate the value with the key (replacing the value if one already exists for key), and return the copy as new immutable map. A copy is always made even if key is already associated with value.

Specified by:

newWithKeyValue in interface ImmutableCharCharMap

Parameters:

key - the key to add

value - the value to associate with the key in the copy

Returns:

an immutable copy of this map with value associated with key

newWithoutKey

public ImmutableCharCharMap newWithoutKey(char key)

Description copied from interface: ImmutableCharCharMap

Copy this map, remove any associated value with the key (if one exists), and return the copy as a new immutable map.

Specified by:

newWithoutKey in interface ImmutableCharCharMap

Parameters:

key - the key to remove

Returns:

an immutable copy of this map with key removed

newWithoutAllKeys

public ImmutableCharCharMap newWithoutAllKeys(CharIterable keys)

Description copied from interface: ImmutableCharCharMap

Copy this map, remove any associated values with the specified keys (if any exist), and return the copy as a new immutable map.

Specified by:

newWithoutAllKeys in interface ImmutableCharCharMap

Parameters:

keys - the keys to remove

Returns:

an immutable copy of this map with all keys in keys removed

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

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

keySet

public MutableCharSet keySet()

Description copied from interface: CharCharMap

Returns a set containing all the keys in this map. The set is backed by the map, so any modifications to the returned set will affect this map.

Specified by:

keySet in interface CharCharMap

Returns:

a mutable set containing the keys in this map

values

public MutableCharCollection values()

Description copied from interface: CharValuesMap

Returns the values in this map as a separate collection. The returned collection is backed by the map, so any changes made to the returned collection will affect the state of this map.

Specified by:

values in interface CharValuesMap

Returns:

the values as a collection backed by this map

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: CharCharMap

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

Specified by:

equals in interface CharCharMap

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Description copied from interface: CharCharMap

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

Specified by:

hashCode in interface CharCharMap

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Description copied from interface: CharCharMap

Follows the same general contract as AbstractMap.toString()

Specified by:

toString in interface CharCharMap

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this CharCharMap

See Also:

AbstractCollection.toString()

writeReplace

private java.lang.Object writeReplace()