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

Class UnmodifiableIntCharMap

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable, CharIterable, CharValuesMap, IntCharMap, MutableCharValuesMap, MutableIntCharMap, PrimitiveIterable

public final class UnmodifiableIntCharMap
extends java.lang.Object
implements MutableIntCharMap, java.io.Serializable

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

Since:

3.1.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
UnmodifiableIntCharMap(MutableIntCharMap map)

Method Summary

Modifier and Type	Method	Description
char	addToValue(int key, char toBeAdded)
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.
MutableIntCharMap	asSynchronized()
MutableIntCharMap	asUnmodifiable()
double	average()
MutableCharIterator	charIterator()	Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.
void	clear()
<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 the 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 the all of the values specified in the source CharIterable are contained in the CharIterable, and false if they are not.
boolean	containsKey(int key)
boolean	containsValue(char 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 otherMap)	Follows the same general contract as Map.equals(Object).
MutableCharIntMap	flipUniqueValues()	Return the CharIntMap that is obtained by flipping the direction of this map and making the associations from value to key.
void	forEach(CharProcedure procedure)	Applies the CharProcedure to each element in the CharIterable.
void	forEachKey(IntProcedure procedure)
void	forEachKeyValue(IntCharProcedure procedure)
void	forEachValue(CharProcedure procedure)
char	get(int key)
char	getIfAbsent(int key, char ifAbsent)
char	getIfAbsentPut(int key, char value)
char	getIfAbsentPut(int key, CharFunction0 function)
<P> char	getIfAbsentPutWith(int key, CharFunction<? super P> function, P parameter)
char	getIfAbsentPutWithKey(int key, IntToCharFunction function)
char	getOrThrow(int key)
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.
MutableIntSet	keySet()
LazyIntIterable	keysView()
RichIterable<IntCharPair>	keyValuesView()
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	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(int key, char value)
void	putAll(IntCharMap map)
MutableCharBag	reject(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
MutableIntCharMap	reject(IntCharPredicate predicate)
void	remove(int key)
void	removeKey(int key)
char	removeKeyIfAbsent(int key, char value)
MutableCharBag	select(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.
MutableIntCharMap	select(IntCharPredicate predicate)
int	size()	Returns the number of items in this iterable.
long	sum()
char[]	toArray()	Converts the CharIterable to a primitive char array.
MutableCharBag	toBag()	Converts the CharIterable to a new MutableCharBag.
ImmutableIntCharMap	toImmutable()
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()
char	updateValue(int key, char initialValueIfAbsent, CharToCharFunction function)
MutableCharCollection	values()
MutableIntCharMap	withKeyValue(int key, char value)
MutableIntCharMap	withoutAllKeys(IntIterable keys)
MutableIntCharMap	withoutKey(int key)

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

averageIfEmpty, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, flatCollect, medianIfEmpty, reject, select, summaryStatistics

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

tap

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UnmodifiableIntCharMap

public UnmodifiableIntCharMap(MutableIntCharMap map)

Method Detail

clear

public void clear()

Specified by:

clear in interface MutableCharValuesMap

put

public void put(int key,
                char value)

Specified by:

put in interface MutableIntCharMap

putAll

public void putAll(IntCharMap map)

Specified by:

putAll in interface MutableIntCharMap

removeKey

public void removeKey(int key)

Specified by:

removeKey in interface MutableIntCharMap

remove

public void remove(int key)

Specified by:

remove in interface MutableIntCharMap

removeKeyIfAbsent

public char removeKeyIfAbsent(int key,
                              char value)

Specified by:

removeKeyIfAbsent in interface MutableIntCharMap

getIfAbsentPut

public char getIfAbsentPut(int key,
                           char value)

Specified by:

getIfAbsentPut in interface MutableIntCharMap

getIfAbsentPut

public char getIfAbsentPut(int key,
                           CharFunction0 function)

Specified by:

getIfAbsentPut in interface MutableIntCharMap

getIfAbsentPutWithKey

public char getIfAbsentPutWithKey(int key,
                                  IntToCharFunction function)

Specified by:

getIfAbsentPutWithKey in interface MutableIntCharMap

getIfAbsentPutWith

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

Specified by:

getIfAbsentPutWith in interface MutableIntCharMap

updateValue

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

Specified by:

updateValue in interface MutableIntCharMap

get

public char get(int key)

Specified by:

get in interface IntCharMap

getIfAbsent

public char getIfAbsent(int key,
                        char ifAbsent)

Specified by:

getIfAbsent in interface IntCharMap

getOrThrow

public char getOrThrow(int key)

Specified by:

getOrThrow in interface IntCharMap

containsKey

public boolean containsKey(int key)

Specified by:

containsKey in interface IntCharMap

containsValue

public boolean containsValue(char value)

Specified by:

containsValue in interface CharValuesMap

forEachValue

public void forEachValue(CharProcedure procedure)

Specified by:

forEachValue in interface CharValuesMap

forEachKey

public void forEachKey(IntProcedure procedure)

Specified by:

forEachKey in interface IntCharMap

forEachKeyValue

public void forEachKeyValue(IntCharProcedure procedure)

Specified by:

forEachKeyValue in interface IntCharMap

keysView

public LazyIntIterable keysView()

Specified by:

keysView in interface IntCharMap

keyValuesView

public RichIterable<IntCharPair> keyValuesView()

Specified by:

keyValuesView in interface IntCharMap

flipUniqueValues

public MutableCharIntMap flipUniqueValues()

Description copied from interface: IntCharMap

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

Specified by:

flipUniqueValues in interface IntCharMap

Specified by:

flipUniqueValues in interface MutableIntCharMap

select

public MutableIntCharMap select(IntCharPredicate predicate)

Specified by:

select in interface IntCharMap

Specified by:

select in interface MutableIntCharMap

reject

public MutableIntCharMap reject(IntCharPredicate predicate)

Specified by:

reject in interface IntCharMap

Specified by:

reject in interface MutableIntCharMap

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

forEach

public void forEach(CharProcedure procedure)

Description copied from interface: CharIterable

Applies the CharProcedure to each element in the CharIterable.

Specified by:

forEach 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 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(int key,
                       char toBeAdded)

Specified by:

addToValue in interface MutableIntCharMap

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

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 the 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 the 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 MutableIntCharMap withKeyValue(int key,
                                      char value)

Specified by:

withKeyValue in interface MutableIntCharMap

withoutKey

public MutableIntCharMap withoutKey(int key)

Specified by:

withoutKey in interface MutableIntCharMap

withoutAllKeys

public MutableIntCharMap withoutAllKeys(IntIterable keys)

Specified by:

withoutAllKeys in interface MutableIntCharMap

asUnmodifiable

public MutableIntCharMap asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableIntCharMap

asSynchronized

public MutableIntCharMap asSynchronized()

Specified by:

asSynchronized in interface MutableIntCharMap

toImmutable

public ImmutableIntCharMap toImmutable()

Specified by:

toImmutable in interface IntCharMap

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 MutableIntSet keySet()

Specified by:

keySet in interface IntCharMap

values

public MutableCharCollection values()

Specified by:

values in interface CharValuesMap

equals

public boolean equals(java.lang.Object otherMap)

Description copied from interface: IntCharMap

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

Specified by:

equals in interface IntCharMap

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Description copied from interface: IntCharMap

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

Specified by:

hashCode in interface IntCharMap

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Description copied from interface: IntCharMap

Follows the same general contract as AbstractMap.toString()

Specified by:

toString in interface IntCharMap

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this IntCharMap

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

injectInto

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

Specified by:

injectInto in interface CharIterable