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

Class UnmodifiableDoubleCharMap

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable, CharIterable, CharValuesMap, DoubleCharMap, MutableCharValuesMap, MutableDoubleCharMap, PrimitiveIterable

public class UnmodifiableDoubleCharMap
extends java.lang.Object
implements MutableDoubleCharMap, 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
UnmodifiableDoubleCharMap(MutableDoubleCharMap map)

Method Summary

Modifier and Type	Method	Description
char	addToValue(double 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.
MutableDoubleCharMap	asSynchronized()
MutableDoubleCharMap	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(double 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).
MutableCharDoubleMap	flipUniqueValues()	Return the CharDoubleMap 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(DoubleProcedure procedure)
void	forEachKeyValue(DoubleCharProcedure procedure)
void	forEachValue(CharProcedure procedure)
char	get(double key)
char	getIfAbsent(double key, char ifAbsent)
char	getIfAbsentPut(double key, char value)
char	getIfAbsentPut(double key, CharFunction0 function)
<P> char	getIfAbsentPutWith(double key, CharFunction<? super P> function, P parameter)
char	getIfAbsentPutWithKey(double key, DoubleToCharFunction function)
char	getOrThrow(double 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.
MutableDoubleSet	keySet()
LazyDoubleIterable	keysView()
RichIterable<DoubleCharPair>	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(double key, char value)
void	putAll(DoubleCharMap map)
void	putPair(DoubleCharPair keyValuePair)	This method allows MutableDoubleCharMap the ability to add an element in the form of DoubleCharPair.
MutableCharBag	reject(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
MutableDoubleCharMap	reject(DoubleCharPredicate predicate)
void	remove(double key)
void	removeKey(double key)
char	removeKeyIfAbsent(double 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.
MutableDoubleCharMap	select(DoubleCharPredicate 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.
ImmutableDoubleCharMap	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(double key, char initialValueIfAbsent, CharToCharFunction function)
void	updateValues(DoubleCharToCharFunction function)	Updates the values in-place.
MutableCharCollection	values()
MutableDoubleCharMap	withKeyValue(double key, char value)
MutableDoubleCharMap	withoutAllKeys(DoubleIterable keys)
MutableDoubleCharMap	withoutKey(double 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.MutableDoubleCharMap

withAllKeyValues

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UnmodifiableDoubleCharMap

public UnmodifiableDoubleCharMap(MutableDoubleCharMap map)

Method Detail

clear

public void clear()

Specified by:

clear in interface MutableCharValuesMap

put

public void put(double key,
                char value)

Specified by:

put in interface MutableDoubleCharMap

putPair

public void putPair(DoubleCharPair keyValuePair)

Description copied from interface: MutableDoubleCharMap

This method allows MutableDoubleCharMap the ability to add an element in the form of DoubleCharPair.

Specified by:

putPair in interface MutableDoubleCharMap

See Also:

MutableDoubleCharMap.put(double, char)

putAll

public void putAll(DoubleCharMap map)

Specified by:

putAll in interface MutableDoubleCharMap

updateValues

public void updateValues(DoubleCharToCharFunction function)

Description copied from interface: MutableDoubleCharMap

Updates the values in-place.

Specified by:

updateValues in interface MutableDoubleCharMap

Parameters:

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

removeKey

public void removeKey(double key)

Specified by:

removeKey in interface MutableDoubleCharMap

remove

public void remove(double key)

Specified by:

remove in interface MutableDoubleCharMap

removeKeyIfAbsent

public char removeKeyIfAbsent(double key,
                              char value)

Specified by:

removeKeyIfAbsent in interface MutableDoubleCharMap

getIfAbsentPut

public char getIfAbsentPut(double key,
                           char value)

Specified by:

getIfAbsentPut in interface MutableDoubleCharMap

getIfAbsentPut

public char getIfAbsentPut(double key,
                           CharFunction0 function)

Specified by:

getIfAbsentPut in interface MutableDoubleCharMap

getIfAbsentPutWithKey

public char getIfAbsentPutWithKey(double key,
                                  DoubleToCharFunction function)

Specified by:

getIfAbsentPutWithKey in interface MutableDoubleCharMap

getIfAbsentPutWith

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

Specified by:

getIfAbsentPutWith in interface MutableDoubleCharMap

updateValue

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

Specified by:

updateValue in interface MutableDoubleCharMap

get

public char get(double key)

Specified by:

get in interface DoubleCharMap

getIfAbsent

public char getIfAbsent(double key,
                        char ifAbsent)

Specified by:

getIfAbsent in interface DoubleCharMap

getOrThrow

public char getOrThrow(double key)

Specified by:

getOrThrow in interface DoubleCharMap

containsKey

public boolean containsKey(double key)

Specified by:

containsKey in interface DoubleCharMap

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

Specified by:

forEachKey in interface DoubleCharMap

forEachKeyValue

public void forEachKeyValue(DoubleCharProcedure procedure)

Specified by:

forEachKeyValue in interface DoubleCharMap

keysView

public LazyDoubleIterable keysView()

Specified by:

keysView in interface DoubleCharMap

keyValuesView

public RichIterable<DoubleCharPair> keyValuesView()

Specified by:

keyValuesView in interface DoubleCharMap

flipUniqueValues

public MutableCharDoubleMap flipUniqueValues()

Description copied from interface: DoubleCharMap

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

Specified by:

flipUniqueValues in interface DoubleCharMap

Specified by:

flipUniqueValues in interface MutableDoubleCharMap

select

public MutableDoubleCharMap select(DoubleCharPredicate predicate)

Specified by:

select in interface DoubleCharMap

Specified by:

select in interface MutableDoubleCharMap

reject

public MutableDoubleCharMap reject(DoubleCharPredicate predicate)

Specified by:

reject in interface DoubleCharMap

Specified by:

reject in interface MutableDoubleCharMap

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

Specified by:

addToValue in interface MutableDoubleCharMap

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 MutableDoubleCharMap withKeyValue(double key,
                                         char value)

Specified by:

withKeyValue in interface MutableDoubleCharMap

withoutKey

public MutableDoubleCharMap withoutKey(double key)

Specified by:

withoutKey in interface MutableDoubleCharMap

withoutAllKeys

public MutableDoubleCharMap withoutAllKeys(DoubleIterable keys)

Specified by:

withoutAllKeys in interface MutableDoubleCharMap

asUnmodifiable

public MutableDoubleCharMap asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableDoubleCharMap

asSynchronized

public MutableDoubleCharMap asSynchronized()

Specified by:

asSynchronized in interface MutableDoubleCharMap

toImmutable

public ImmutableDoubleCharMap toImmutable()

Specified by:

toImmutable in interface DoubleCharMap

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

Specified by:

keySet in interface DoubleCharMap

values

public MutableCharCollection values()

Specified by:

values in interface CharValuesMap

equals

public boolean equals(java.lang.Object otherMap)

Description copied from interface: DoubleCharMap

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

Specified by:

equals in interface DoubleCharMap

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Description copied from interface: DoubleCharMap

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

Specified by:

hashCode in interface DoubleCharMap

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Description copied from interface: DoubleCharMap

Follows the same general contract as AbstractMap.toString()

Specified by:

toString in interface DoubleCharMap

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this DoubleCharMap

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.