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

Class UnmodifiableObjectCharMap<K>

java.lang.Object

org.eclipse.collections.impl.map.mutable.primitive.UnmodifiableObjectCharMap<K>

All Implemented Interfaces:

java.io.Serializable, CharIterable, MutableObjectCharMap<K>, ObjectCharMap<K>, PrimitiveIterable

public class UnmodifiableObjectCharMap<K>
extends java.lang.Object
implements MutableObjectCharMap<K>, java.io.Serializable

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

Since:

3.2

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
UnmodifiableObjectCharMap(MutableObjectCharMap<K> map)

Method Summary

Modifier and Type	Method	Description
char	addToValue(K 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.
MutableObjectCharMap<K>	asSynchronized()
MutableObjectCharMap<K>	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()
<V1> MutableCollection<V1>	collect(CharToObjectFunction<? extends V1> 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(java.lang.Object 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 obj)
MutableCharObjectMap<K>	flipUniqueValues()	Return the CharObjectMap 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(Procedure<? super K> procedure)
void	forEachKeyValue(ObjectCharProcedure<? super K> procedure)
void	forEachValue(CharProcedure procedure)
char	get(java.lang.Object key)
char	getIfAbsent(java.lang.Object key, char ifAbsent)
char	getIfAbsentPut(K key, char value)
char	getIfAbsentPut(K key, CharFunction0 function)
<P> char	getIfAbsentPutWith(K key, CharFunction<? super P> function, P parameter)
char	getIfAbsentPutWithKey(K key, CharFunction<? super K> function)
char	getOrThrow(java.lang.Object key)
int	hashCode()
<T> T	injectInto(T injectedValue, ObjectCharToObjectFunction<? super T,? extends T> function)
boolean	isEmpty()	Returns true if this iterable has zero items.
java.util.Set<K>	keySet()
LazyIterable<K>	keysView()
RichIterable<ObjectCharPair<K>>	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(K key, char value)
void	putAll(ObjectCharMap<? extends K> map)
void	putPair(ObjectCharPair<K> keyValuePair)	This method allows MutableObjectCharMap the ability to add an element in the form of ObjectCharPair<K>.
MutableCharCollection	reject(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
MutableObjectCharMap<K>	reject(ObjectCharPredicate<? super K> predicate)
void	remove(java.lang.Object key)
void	removeKey(K key)
char	removeKeyIfAbsent(K key, char value)
MutableCharCollection	select(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.
MutableObjectCharMap<K>	select(ObjectCharPredicate<? super K> 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.
ImmutableObjectCharMap<K>	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(K key, char initialValueIfAbsent, CharToCharFunction function)
void	updateValues(ObjectCharToCharFunction<? super K> function)	Updates the values in-place.
MutableCharCollection	values()
MutableObjectCharMap<K>	withKeyValue(K key, char value)
MutableObjectCharMap<K>	withoutAllKeys(java.lang.Iterable<? extends K> keys)
MutableObjectCharMap<K>	withoutKey(K 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.MutableObjectCharMap

tap, withAllKeyValues

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UnmodifiableObjectCharMap

public UnmodifiableObjectCharMap(MutableObjectCharMap<K> map)

Method Detail

clear

public void clear()

Specified by:

clear in interface MutableObjectCharMap<K>

put

public void put(K key,
                char value)

Specified by:

put in interface MutableObjectCharMap<K>

putPair

public void putPair(ObjectCharPair<K> keyValuePair)

Description copied from interface: MutableObjectCharMap

This method allows MutableObjectCharMap the ability to add an element in the form of ObjectCharPair<K>.

Specified by:

putPair in interface MutableObjectCharMap<K>

See Also:

MutableObjectCharMap.put(Object, char)

putAll

public void putAll(ObjectCharMap<? extends K> map)

Specified by:

putAll in interface MutableObjectCharMap<K>

updateValues

public void updateValues(ObjectCharToCharFunction<? super K> function)

Description copied from interface: MutableObjectCharMap

Updates the values in-place.

Specified by:

updateValues in interface MutableObjectCharMap<K>

Parameters:

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

removeKey

public void removeKey(K key)

Specified by:

removeKey in interface MutableObjectCharMap<K>

remove

public void remove(java.lang.Object key)

Specified by:

remove in interface MutableObjectCharMap<K>

removeKeyIfAbsent

public char removeKeyIfAbsent(K key,
                              char value)

Specified by:

removeKeyIfAbsent in interface MutableObjectCharMap<K>

getIfAbsentPut

public char getIfAbsentPut(K key,
                           char value)

Specified by:

getIfAbsentPut in interface MutableObjectCharMap<K>

getIfAbsentPut

public char getIfAbsentPut(K key,
                           CharFunction0 function)

Specified by:

getIfAbsentPut in interface MutableObjectCharMap<K>

getIfAbsentPutWithKey

public char getIfAbsentPutWithKey(K key,
                                  CharFunction<? super K> function)

Specified by:

getIfAbsentPutWithKey in interface MutableObjectCharMap<K>

getIfAbsentPutWith

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

Specified by:

getIfAbsentPutWith in interface MutableObjectCharMap<K>

updateValue

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

Specified by:

updateValue in interface MutableObjectCharMap<K>

addToValue

public char addToValue(K key,
                       char toBeAdded)

Specified by:

addToValue in interface MutableObjectCharMap<K>

get

public char get(java.lang.Object key)

Specified by:

get in interface ObjectCharMap<K>

getOrThrow

public char getOrThrow(java.lang.Object key)

Specified by:

getOrThrow in interface ObjectCharMap<K>

getIfAbsent

public char getIfAbsent(java.lang.Object key,
                        char ifAbsent)

Specified by:

getIfAbsent in interface ObjectCharMap<K>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface ObjectCharMap<K>

containsValue

public boolean containsValue(char value)

Specified by:

containsValue in interface ObjectCharMap<K>

forEachValue

public void forEachValue(CharProcedure procedure)

Specified by:

forEachValue in interface ObjectCharMap<K>

forEachKey

public void forEachKey(Procedure<? super K> procedure)

Specified by:

forEachKey in interface ObjectCharMap<K>

forEachKeyValue

public void forEachKeyValue(ObjectCharProcedure<? super K> procedure)

Specified by:

forEachKeyValue in interface ObjectCharMap<K>

select

public MutableObjectCharMap<K> select(ObjectCharPredicate<? super K> predicate)

Specified by:

select in interface MutableObjectCharMap<K>

Specified by:

select in interface ObjectCharMap<K>

reject

public MutableObjectCharMap<K> reject(ObjectCharPredicate<? super K> predicate)

Specified by:

reject in interface MutableObjectCharMap<K>

Specified by:

reject in interface ObjectCharMap<K>

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 MutableObjectCharMap<K>

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 MutableCharCollection 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 MutableObjectCharMap<K>

reject

public MutableCharCollection 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 MutableObjectCharMap<K>

detectIfNone

public char detectIfNone(CharPredicate predicate,
                         char ifNone)

Specified by:

detectIfNone in interface CharIterable

collect

public <V1> MutableCollection<V1> collect(CharToObjectFunction<? extends V1> 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 MutableObjectCharMap<K>

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

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 MutableObjectCharMap<K> withKeyValue(K key,
                                            char value)

Specified by:

withKeyValue in interface MutableObjectCharMap<K>

withoutKey

public MutableObjectCharMap<K> withoutKey(K key)

Specified by:

withoutKey in interface MutableObjectCharMap<K>

withoutAllKeys

public MutableObjectCharMap<K> withoutAllKeys(java.lang.Iterable<? extends K> keys)

Specified by:

withoutAllKeys in interface MutableObjectCharMap<K>

asUnmodifiable

public MutableObjectCharMap<K> asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableObjectCharMap<K>

asSynchronized

public MutableObjectCharMap<K> asSynchronized()

Specified by:

asSynchronized in interface MutableObjectCharMap<K>

toImmutable

public ImmutableObjectCharMap<K> toImmutable()

Specified by:

toImmutable in interface ObjectCharMap<K>

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 java.util.Set<K> keySet()

Specified by:

keySet in interface ObjectCharMap<K>

values

public MutableCharCollection values()

Specified by:

values in interface ObjectCharMap<K>

keysView

public LazyIterable<K> keysView()

Specified by:

keysView in interface ObjectCharMap<K>

keyValuesView

public RichIterable<ObjectCharPair<K>> keyValuesView()

Specified by:

keyValuesView in interface ObjectCharMap<K>

flipUniqueValues

public MutableCharObjectMap<K> flipUniqueValues()

Description copied from interface: ObjectCharMap

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

Specified by:

flipUniqueValues in interface MutableObjectCharMap<K>

Specified by:

flipUniqueValues in interface ObjectCharMap<K>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Description copied from interface: ObjectCharMap

Follows the same general contract as AbstractMap.toString()

Specified by:

toString in interface ObjectCharMap<K>

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this ObjectCharMap

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

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.