Package org.eclipse.collections.api.map.primitive

Interface ImmutableObjectCharMap<K>

All Superinterfaces:

CharIterable, ObjectCharMap<K>, PrimitiveIterable

All Known Implementing Classes:

AbstractImmutableObjectCharMap

public interface ImmutableObjectCharMap<K>
extends ObjectCharMap<K>

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

Since:

3.0.

Method Summary

Modifier and Type	Method	Description
<V> ImmutableCollection<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.
ImmutableCharObjectMap<K>	flipUniqueValues()	Return the CharObjectMap that is obtained by flipping the direction of this map and making the associations from value to key.
ImmutableObjectCharMap<K>	newWithKeyValue(K key, char value)	Copy this map, associate the value with the key (replacing the value if one already exists for key), and return the copy as new immutable map.
ImmutableObjectCharMap<K>	newWithoutAllKeys(Iterable<? extends K> keys)	Copy this map, remove any associated values with the specified keys (if any exist), and return the copy as a new immutable map.
ImmutableObjectCharMap<K>	newWithoutKey(K key)	Copy this map, remove any associated value with the key (if one exists), and return the copy as a new immutable map.
ImmutableCharCollection	reject(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
ImmutableObjectCharMap<K>	reject(ObjectCharPredicate<? super K> predicate)	Return a copy of this map containing only the key/value pairs that do not match the predicate.
ImmutableCharCollection	select(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.
ImmutableObjectCharMap<K>	select(ObjectCharPredicate<? super K> predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
default ImmutableObjectCharMap<K>	tap(CharProcedure procedure)

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

allSatisfy, anySatisfy, asLazy, average, averageIfEmpty, charIterator, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, contains, containsAll, containsAll, count, detectIfNone, each, flatCollect, forEach, injectInto, max, maxIfEmpty, median, medianIfEmpty, min, minIfEmpty, noneSatisfy, reduce, reduceIfEmpty, reject, select, sum, summaryStatistics, toArray, toArray, toBag, toList, toSet, toSortedArray, toSortedList

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

containsKey, containsValue, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getOrThrow, keySet, keysView, keyValuesView, toImmutable, toString, values

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

appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size

Method Details

select

ImmutableObjectCharMap<K> select(ObjectCharPredicate<? super K> predicate)

Description copied from interface: ObjectCharMap

Return a copy of this map containing only the key/value pairs that match the predicate.

Specified by:

select in interface ObjectCharMap<K>

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

ImmutableObjectCharMap<K> reject(ObjectCharPredicate<? super K> predicate)

Description copied from interface: ObjectCharMap

Return a copy of this map containing only the key/value pairs that do not match the predicate.

Specified by:

reject in interface ObjectCharMap<K>

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

select

ImmutableCharCollection 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

reject

ImmutableCharCollection 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

tap

default ImmutableObjectCharMap<K> tap(CharProcedure procedure)

Specified by:

tap in interface CharIterable

Specified by:

tap in interface ObjectCharMap<K>

Since:

9.0.

collect

<V> ImmutableCollection<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

newWithKeyValue

ImmutableObjectCharMap<K> newWithKeyValue(K key, char value)

Copy this map, associate the value with the key (replacing the value if one already exists for key), and return the copy as new immutable map. A copy is always made even if key is already associated with value.

Parameters:

key - the key to add

value - the value to associate with the key in the copy

Returns:

an immutable copy of this map with value associated with key

newWithoutKey

ImmutableObjectCharMap<K> newWithoutKey(K key)

Copy this map, remove any associated value with the key (if one exists), and return the copy as a new immutable map.

Parameters:

key - the key to remove

Returns:

an immutable copy of this map with key removed

newWithoutAllKeys

ImmutableObjectCharMap<K> newWithoutAllKeys(Iterable<? extends K> keys)

Copy this map, remove any associated values with the specified keys (if any exist), and return the copy as a new immutable map.

Parameters:

keys - the keys to remove

Returns:

an immutable copy of this map with all keys in keys removed

flipUniqueValues

ImmutableCharObjectMap<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 ObjectCharMap<K>