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

Class UnmodifiableShortCharMap

java.lang.Object

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

All Implemented Interfaces:

Serializable, CharIterable, CharValuesMap, MutableCharValuesMap, MutableShortCharMap, ShortCharMap, PrimitiveIterable

public class UnmodifiableShortCharMap
extends Object
implements MutableShortCharMap, Serializable

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

Since:

3.1.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
UnmodifiableShortCharMap(MutableShortCharMap map)

Method Summary

Modifier and Type	Method	Description
char	addToValue(short 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(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.
MutableShortCharMap	asSynchronized()
MutableShortCharMap	asUnmodifiable()
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()
<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(short 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(Object otherMap)	Follows the same general contract as Map.equals(Object).
MutableCharShortMap	flipUniqueValues()	Return the CharShortMap 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(ShortProcedure procedure)
void	forEachKeyValue(ShortCharProcedure procedure)
void	forEachValue(CharProcedure procedure)
char	get(short key)
char	getIfAbsent(short key, char ifAbsent)
char	getIfAbsentPut(short key, char value)
char	getIfAbsentPut(short key, CharFunction0 function)
<P> char	getIfAbsentPutWith(short key, CharFunction<? super P> function, P parameter)
char	getIfAbsentPutWithKey(short key, ShortToCharFunction function)
char	getOrThrow(short 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.
MutableShortSet	keySet()
LazyShortIterable	keysView()
RichIterable<ShortCharPair>	keyValuesView()
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(short key, char value)
void	putAll(ShortCharMap map)
void	putPair(ShortCharPair keyValuePair)	This method allows MutableShortCharMap the ability to add an element in the form of ShortCharPair.
MutableCharBag	reject(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
MutableShortCharMap	reject(ShortCharPredicate predicate)
void	remove(short key)
void	removeKey(short key)
char	removeKeyIfAbsent(short 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.
MutableShortCharMap	select(ShortCharPredicate 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.
ImmutableShortCharMap	toImmutable()
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(short key, char initialValueIfAbsent, CharToCharFunction function)
void	updateValues(ShortCharToCharFunction function)	Updates the values in-place.
MutableCharCollection	values()
MutableShortCharMap	withKeyValue(short key, char value)
MutableShortCharMap	withoutAllKeys(ShortIterable keys)
MutableShortCharMap	withoutKey(short key)

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

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

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

tap

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

withAllKeyValues

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UnmodifiableShortCharMap

public UnmodifiableShortCharMap(MutableShortCharMap map)

Method Detail

clear

public void clear()

Specified by:

clear in interface MutableCharValuesMap

put

public void put(short key,
                char value)

Specified by:

put in interface MutableShortCharMap

putPair

public void putPair(ShortCharPair keyValuePair)

Description copied from interface: MutableShortCharMap

This method allows MutableShortCharMap the ability to add an element in the form of ShortCharPair.

Specified by:

putPair in interface MutableShortCharMap

See Also:

MutableShortCharMap.put(short, char)

putAll

public void putAll(ShortCharMap map)

Specified by:

putAll in interface MutableShortCharMap

updateValues

public void updateValues(ShortCharToCharFunction function)

Description copied from interface: MutableShortCharMap

Updates the values in-place.

Specified by:

updateValues in interface MutableShortCharMap

Parameters:

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

removeKey

public void removeKey(short key)

Specified by:

removeKey in interface MutableShortCharMap

remove

public void remove(short key)

Specified by:

remove in interface MutableShortCharMap

removeKeyIfAbsent

public char removeKeyIfAbsent(short key,
                              char value)

Specified by:

removeKeyIfAbsent in interface MutableShortCharMap

getIfAbsentPut

public char getIfAbsentPut(short key,
                           char value)

Specified by:

getIfAbsentPut in interface MutableShortCharMap

getIfAbsentPut

public char getIfAbsentPut(short key,
                           CharFunction0 function)

Specified by:

getIfAbsentPut in interface MutableShortCharMap

getIfAbsentPutWithKey

public char getIfAbsentPutWithKey(short key,
                                  ShortToCharFunction function)

Specified by:

getIfAbsentPutWithKey in interface MutableShortCharMap

getIfAbsentPutWith

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

Specified by:

getIfAbsentPutWith in interface MutableShortCharMap

updateValue

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

Specified by:

updateValue in interface MutableShortCharMap

get

public char get(short key)

Specified by:

get in interface ShortCharMap

getIfAbsent

public char getIfAbsent(short key,
                        char ifAbsent)

Specified by:

getIfAbsent in interface ShortCharMap

getOrThrow

public char getOrThrow(short key)

Specified by:

getOrThrow in interface ShortCharMap

containsKey

public boolean containsKey(short key)

Specified by:

containsKey in interface ShortCharMap

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(ShortProcedure procedure)

Specified by:

forEachKey in interface ShortCharMap

forEachKeyValue

public void forEachKeyValue(ShortCharProcedure procedure)

Specified by:

forEachKeyValue in interface ShortCharMap

keysView

public LazyShortIterable keysView()

Specified by:

keysView in interface ShortCharMap

keyValuesView

public RichIterable<ShortCharPair> keyValuesView()

Specified by:

keyValuesView in interface ShortCharMap

flipUniqueValues

public MutableCharShortMap flipUniqueValues()

Description copied from interface: ShortCharMap

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

Specified by:

flipUniqueValues in interface MutableShortCharMap

Specified by:

flipUniqueValues in interface ShortCharMap

select

public MutableShortCharMap select(ShortCharPredicate predicate)

Specified by:

select in interface MutableShortCharMap

Specified by:

select in interface ShortCharMap

reject

public MutableShortCharMap reject(ShortCharPredicate predicate)

Specified by:

reject in interface MutableShortCharMap

Specified by:

reject in interface ShortCharMap

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

Specified by:

addToValue in interface MutableShortCharMap

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 MutableShortCharMap withKeyValue(short key,
                                        char value)

Specified by:

withKeyValue in interface MutableShortCharMap

withoutKey

public MutableShortCharMap withoutKey(short key)

Specified by:

withoutKey in interface MutableShortCharMap

withoutAllKeys

public MutableShortCharMap withoutAllKeys(ShortIterable keys)

Specified by:

withoutAllKeys in interface MutableShortCharMap

asUnmodifiable

public MutableShortCharMap asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableShortCharMap

asSynchronized

public MutableShortCharMap asSynchronized()

Specified by:

asSynchronized in interface MutableShortCharMap

toImmutable

public ImmutableShortCharMap toImmutable()

Specified by:

toImmutable in interface ShortCharMap

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

Specified by:

keySet in interface ShortCharMap

values

public MutableCharCollection values()

Specified by:

values in interface CharValuesMap

equals

public boolean equals(Object otherMap)

Description copied from interface: ShortCharMap

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

Specified by:

equals in interface ShortCharMap

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: ShortCharMap

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

Specified by:

hashCode in interface ShortCharMap

Overrides:

hashCode in class Object

toString

public String toString()

Description copied from interface: ShortCharMap

Follows the same general contract as AbstractMap.toString()

Specified by:

toString in interface PrimitiveIterable

Specified by:

toString in interface ShortCharMap

Overrides:

toString in class Object

Returns:

a string representation of this ShortCharMap

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.