Top Description Methods
org.eclipse.collections.api.map.primitive

public Interface ImmutableObjectCharMap<K>

extends ObjectCharMap<K>
Imports
org.eclipse.collections.api.block.function.primitive.CharToObjectFunction, org.eclipse.collections.api.block.predicate.primitive.ObjectCharPredicate, .CharPredicate, org.eclipse.collections.api.block.procedure.primitive.CharProcedure, org.eclipse.collections.api.collection.ImmutableCollection, org.eclipse.collections.api.collection.primitive.ImmutableCharCollection

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

Method Summary

Modifier and TypeMethod and Description
public <V> ImmutableCollection<V>
collect(CharToObjectFunction<? extends V> function)

Redeclares org.eclipse.collections.api.CharIterable.collect.

Returns a new collection with the results of applying the specified function on each element of the source collection.

public ImmutableCharObjectMap<K>
flipUniqueValues()

Redeclares org.eclipse.collections.api.map.primitive.ObjectCharMap.flipUniqueValues.

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

public ImmutableObjectCharMap<K>

Returns:

an immutable copy of this map with value associated with key
newWithKeyValue
(K
the key to add
key
,
char
the value to associate with the key in the copy
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.

public ImmutableObjectCharMap<K>

Returns:

an immutable copy of this map with all keys in keys removed
newWithoutAllKeys
(Iterable<? extends K>
the keys to remove
keys
)

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

public ImmutableObjectCharMap<K>

Returns:

an immutable copy of this map with key removed
newWithoutKey
(K
the key to remove
key
)

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

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

Redeclares org.eclipse.collections.api.map.primitive.ObjectCharMap.reject.

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

public ImmutableCharCollection
reject(CharPredicate predicate)

Redeclares org.eclipse.collections.api.CharIterable.reject.

Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.

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

Redeclares org.eclipse.collections.api.map.primitive.ObjectCharMap.select.

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

public ImmutableCharCollection
select(CharPredicate predicate)

Redeclares org.eclipse.collections.api.CharIterable.select.

Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.

public default ImmutableObjectCharMap<K>
Inherited from org.eclipse.collections.api.map.primitive.ObjectCharMap:
allSatisfyKeyValuecontainsKeycontainsValueforEachKeyforEachKeyValueforEachValuegetgetIfAbsentgetOrThrowinjectIntoKeyValuekeySetkeysViewkeyValuesViewtoImmutabletoStringvalues

Method Detail

collectback to summary
public <V> ImmutableCollection<V> collect(CharToObjectFunction<? extends V> function)

Redeclares org.eclipse.collections.api.CharIterable.collect.

Doc from org.eclipse.collections.api.CharIterable.collect.

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.

Annotations
@Override
flipUniqueValuesback to summary
public ImmutableCharObjectMap<K> flipUniqueValues()

Redeclares org.eclipse.collections.api.map.primitive.ObjectCharMap.flipUniqueValues.

Doc from org.eclipse.collections.api.map.primitive.ObjectCharMap.flipUniqueValues.

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

Annotations
@Override
newWithKeyValueback to summary
public 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:K

the key to add

value:char

the value to associate with the key in the copy

Returns:ImmutableObjectCharMap<K>

an immutable copy of this map with value associated with key

newWithoutAllKeysback to summary
public 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:Iterable<? extends K>

the keys to remove

Returns:ImmutableObjectCharMap<K>

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

newWithoutKeyback to summary
public 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:K

the key to remove

Returns:ImmutableObjectCharMap<K>

an immutable copy of this map with key removed

rejectback to summary
public ImmutableObjectCharMap<K> reject(ObjectCharPredicate<? super K> predicate)

Redeclares org.eclipse.collections.api.map.primitive.ObjectCharMap.reject.

Doc from org.eclipse.collections.api.map.primitive.ObjectCharMap.reject.

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

Annotations
@Override
rejectback to summary
public ImmutableCharCollection reject(CharPredicate predicate)

Redeclares org.eclipse.collections.api.CharIterable.reject.

Doc from org.eclipse.collections.api.CharIterable.reject.

Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.

Annotations
@Override
selectback to summary
public ImmutableObjectCharMap<K> select(ObjectCharPredicate<? super K> predicate)

Redeclares org.eclipse.collections.api.map.primitive.ObjectCharMap.select.

Doc from org.eclipse.collections.api.map.primitive.ObjectCharMap.select.

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

Annotations
@Override
selectback to summary
public ImmutableCharCollection select(CharPredicate predicate)

Redeclares org.eclipse.collections.api.CharIterable.select.

Doc from org.eclipse.collections.api.CharIterable.select.

Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.

Annotations
@Override
tapback to summary
public default ImmutableObjectCharMap<K> tap(CharProcedure procedure)

Overrides default org.eclipse.collections.api.map.primitive.ObjectCharMap.tap.

Annotations
@Override
Since
9.0.