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

Class UnmodifiableCharCharMap

java.lang.Object

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

All Implemented Interfaces:

Serializable, CharIterable, CharCharMap, CharValuesMap, MutableCharCharMap, MutableCharValuesMap, PrimitiveIterable

public class UnmodifiableCharCharMap
extends Object
implements MutableCharCharMap, Serializable

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

Since:

3.1.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
UnmodifiableCharCharMap(MutableCharCharMap map)

Method Summary

Modifier and Type	Method	Description
char	addToValue(char key, char toBeAdded)	Increments and updates the value associated with the key, if a value exists, or sets the value to be the specified value if one does not.
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(Appendable appendable)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String separator)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String start, String separator, String end)	Prints a string representation of this collection onto the given Appendable.
LazyCharIterable	asLazy()	Returns a LazyCharIterable adapter wrapping the source CharIterable.
MutableCharCharMap	asSynchronized()	Returns a synchronized view of this map, delegating all operations to this map but ensuring only one caller has access to the map at a time.
MutableCharCharMap	asUnmodifiable()	Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations.
double	average()
MutableCharIterator	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.
void	clear()	Removes all entries from this map.
<V> MutableBag<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(Object otherMap)	Follows the same general contract as Map.equals(Object).
MutableCharCharMap	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	getAndPut(char key, char putValue, char defaultValue)	Retrieves the value associated with the key if one exists; associates a putValue 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	getIfAbsentPut(char key, char value)	Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
char	getIfAbsentPut(char key, CharFunction0 function)	Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.
<P> char	getIfAbsentPutWith(char key, CharFunction<? super P> function, P parameter)	Retrieves the value associated with the key if one exists; if it does not, invokes the value function with the parameter and associates the result with the key.
char	getIfAbsentPutWithKey(char key, CharToCharFunction function)	Retrieves the value associated with the key if one exists; if it does not, associates the result of invoking the value function with the key.
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.
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).
String	makeString(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).
String	makeString(String start, String separator, 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	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()
void	put(char key, char value)	Associates a value with the specified key.
void	putAll(CharCharMap map)	Puts all of the key/value mappings from the specified map into this map.
void	putPair(CharCharPair keyValuePair)	This method allows MutableCharCharMap the ability to add an element in the form of CharCharPair.
MutableCharCharMap	reject(CharCharPredicate predicate)	Return a copy of this map containing only the key/value pairs that do not match the predicate.
MutableCharBag	reject(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
void	remove(char key)	Removes the mapping associated with the key, if one exists, from the map.
void	removeKey(char key)	Removes the mapping associated with the key, if one exists, from the map.
char	removeKeyIfAbsent(char key, char value)	Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
MutableCharCharMap	select(CharCharPredicate predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
MutableCharBag	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()
String	toString()	Follows the same general contract as AbstractMap.toString()
char	updateValue(char key, char initialValueIfAbsent, CharToCharFunction function)	Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or to the specified initial value if one does not.
void	updateValues(CharCharToCharFunction function)	Updates the values in-place.
MutableCharCollection	values()	Returns the values in this map as a separate collection.
MutableCharCharMap	withKeyValue(char key, char value)	Associates a value with the specified key.
MutableCharCharMap	withoutAllKeys(CharIterable keys)	Removes the mappings associated with all the keys, if they exist, from this map.
MutableCharCharMap	withoutKey(char key)	Removes the mapping associated with the key, if one exists, from this map.

Methods inherited from class java.lang.Object

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

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

withAllKeyValues

Constructor Details

UnmodifiableCharCharMap

public UnmodifiableCharCharMap(MutableCharCharMap map)

Method Details

clear

public void clear()

Description copied from interface: MutableCharValuesMap

Removes all entries from this map.

Specified by:

clear in interface MutableCharValuesMap

put

public void put(char key,
 char value)

Description copied from interface: MutableCharCharMap

Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.

Specified by:

put in interface MutableCharCharMap

Parameters:

key - the key

value - the value to associate with value

putPair

public void putPair(CharCharPair keyValuePair)

Description copied from interface: MutableCharCharMap

This method allows MutableCharCharMap the ability to add an element in the form of CharCharPair.

Specified by:

putPair in interface MutableCharCharMap

See Also:

• MutableCharCharMap.put(char, char)

putAll

public void putAll(CharCharMap map)

Description copied from interface: MutableCharCharMap

Puts all of the key/value mappings from the specified map into this map. If this map already has a value associated with one of the keys in the map, it will be replaced with the value in map.

Specified by:

putAll in interface MutableCharCharMap

Parameters:

map - the map to copy into this map

updateValues

public void updateValues(CharCharToCharFunction function)

Description copied from interface: MutableCharCharMap

Updates the values in-place.

Specified by:

updateValues in interface MutableCharCharMap

Parameters:

function - that takes a key and its value and that returns a new value for this key

removeKey

public void removeKey(char key)

Description copied from interface: MutableCharCharMap

Removes the mapping associated with the key, if one exists, from the map.

Specified by:

removeKey in interface MutableCharCharMap

Parameters:

key - the key to remove

See Also:

• MutableCharCharMap.remove(char)

remove

public void remove(char key)

Description copied from interface: MutableCharCharMap

Removes the mapping associated with the key, if one exists, from the map.

Specified by:

remove in interface MutableCharCharMap

Parameters:

key - the key to remove

See Also:

• MutableCharCharMap.removeKey(char)

removeKeyIfAbsent

public char removeKeyIfAbsent(char key,
 char value)

Description copied from interface: MutableCharCharMap

Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key. If no mapping existed for the key, the specified default value is returned.

Specified by:

removeKeyIfAbsent in interface MutableCharCharMap

Parameters:

key - the key to remove

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

Returns:

the value previously associated with the key, if one existed, or value if not

getIfAbsentPut

public char getIfAbsentPut(char key,
 char value)

Description copied from interface: MutableCharCharMap

Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.

Specified by:

getIfAbsentPut in interface MutableCharCharMap

Parameters:

key - the key

value - the value to associate with key if no such mapping exists

Returns:

the value associated with key, if one exists, or value if not

getAndPut

public char getAndPut(char key,
 char putValue,
 char defaultValue)

Description copied from interface: MutableCharCharMap

Retrieves the value associated with the key if one exists; associates a putValue with the key.

Specified by:

getAndPut in interface MutableCharCharMap

Parameters:

key - the key

putValue - the value to associate with key if no such mapping exists

defaultValue - the value to return if no mapping associated with key exists

Returns:

the value associated with key, if one exists, or defaultValue if not

getIfAbsentPut

public char getIfAbsentPut(char key,
 CharFunction0 function)

Description copied from interface: MutableCharCharMap

Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.

Specified by:

getIfAbsentPut in interface MutableCharCharMap

Parameters:

key - the key

function - the supplier that provides the value if no mapping exists for key

Returns:

the value associated with the key, if one exists, or the result of invoking function if not

getIfAbsentPutWithKey

public char getIfAbsentPutWithKey(char key,
 CharToCharFunction function)

Description copied from interface: MutableCharCharMap

Retrieves the value associated with the key if one exists; if it does not, associates the result of invoking the value function with the key.

Specified by:

getIfAbsentPutWithKey in interface MutableCharCharMap

Parameters:

key - the key

function - the function that provides the value if no mapping exists. The key will be passed as the argument to the function.

Returns:

the value associated with the key, if one exists, or the result of invoking function with key if not

getIfAbsentPutWith

public <P> char getIfAbsentPutWith(char key,
 CharFunction<? super P> function,
 P parameter)

Description copied from interface: MutableCharCharMap

Retrieves the value associated with the key if one exists; if it does not, invokes the value function with the parameter and associates the result with the key.

Specified by:

getIfAbsentPutWith in interface MutableCharCharMap

Type Parameters:

P - the type of the value function's parameter

Parameters:

key - the key

function - the function that provides the value if no mapping exists. The specified parameter will be passed as the argument to the function.

parameter - the parameter to provide to function if no value exists for key

Returns:

the value associated with the key, if one exists, or the result of invoking function with parameter if not

updateValue

public char updateValue(char key,
 char initialValueIfAbsent,
 CharToCharFunction function)

Description copied from interface: MutableCharCharMap

Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or to the specified initial value if one does not.

Specified by:

updateValue in interface MutableCharCharMap

Parameters:

key - the key

initialValueIfAbsent - the initial value to supply to the function if no mapping exists for the key

function - the function that returns the updated value based on the current value or the initial value, if no value exists

Returns:

the new value associated with the key, either as a result of applying function to the value already associated with the key or as a result of applying it to initialValueIfAbsent and associating the result with key

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

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 MutableCharCharMap 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 MutableCharCharMap

select

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

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 MutableCharCharMap 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 MutableCharCharMap

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

charIterator

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

Specified by:

charIterator in interface MutableCharValuesMap

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 MutableCharBag 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 MutableCharValuesMap

reject

public MutableCharBag 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 MutableCharValuesMap

collect

public <V> MutableBag<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 MutableCharValuesMap

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

addToValue

public char addToValue(char key,
 char toBeAdded)

Description copied from interface: MutableCharCharMap

Increments and updates the value associated with the key, if a value exists, or sets the value to be the specified value if one does not.

Specified by:

addToValue in interface MutableCharCharMap

Parameters:

key - the key

toBeAdded - the amount to increment the existing value, if one exists, or to use as the initial value if one does not

Returns:

the value after incrementing toBeAdded to the existing value associated with key or toBeAdded if one does not

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

withKeyValue

public MutableCharCharMap withKeyValue(char key,
 char value)

Description copied from interface: MutableCharCharMap

Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.

Specified by:

withKeyValue in interface MutableCharCharMap

Parameters:

key - the key

value - the value to associate with value

Returns:

this map

See Also:

• MutableCharCharMap.put(char, char)

withoutKey

public MutableCharCharMap withoutKey(char key)

Description copied from interface: MutableCharCharMap

Removes the mapping associated with the key, if one exists, from this map.

Specified by:

withoutKey in interface MutableCharCharMap

Parameters:

key - the key to remove

Returns:

this map

See Also:

• MutableCharCharMap.remove(char)

withoutAllKeys

public MutableCharCharMap withoutAllKeys(CharIterable keys)

Description copied from interface: MutableCharCharMap

Removes the mappings associated with all the keys, if they exist, from this map.

Specified by:

withoutAllKeys in interface MutableCharCharMap

Parameters:

keys - the keys to remove

Returns:

this map

See Also:

• MutableCharCharMap.remove(char)

asUnmodifiable

public MutableCharCharMap asUnmodifiable()

Description copied from interface: MutableCharCharMap

Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations. This avoids the overhead of copying the map when calling CharCharMap.toImmutable() while still providing immutability.

Specified by:

asUnmodifiable in interface MutableCharCharMap

Returns:

an unmodifiable view of this map

asSynchronized

public MutableCharCharMap asSynchronized()

Description copied from interface: MutableCharCharMap

Returns a synchronized view of this map, delegating all operations to this map but ensuring only one caller has access to the map at a time.

Specified by:

asSynchronized in interface MutableCharCharMap

Returns:

a synchronized view of this map

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

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

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(Object otherMap)

Description copied from interface: CharCharMap

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

Specified by:

equals in interface CharCharMap

Overrides:

equals in class 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 Object

toString

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

Returns:

a string representation of this CharCharMap

See Also:

• AbstractCollection.toString()

makeString

public 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 String makeString(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 String makeString(String start,
 String separator,
 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(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(Appendable appendable,
 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(Appendable appendable,
 String start,
 String separator,
 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

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.