org.eclipse.collections.api.map.primitive

Interface CharObjectMap<V>

All Superinterfaces:

InternalIterable<V>, Iterable<V>, PrimitiveObjectMap<V>, RichIterable<V>

All Known Subinterfaces:

ImmutableCharObjectMap<V>, MutableCharObjectMap<V>

public interface CharObjectMap<V>
extends PrimitiveObjectMap<V>

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

Since:

3.0.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(char key) Returns whether or not the key is present in the map.
ObjectCharMap<V>	flipUniqueValues() Return the ObjectCharMap that is obtained by flipping the direction of this map and making the associations from value to key.
void	forEachKey(CharProcedure procedure) Iterates through each key in the map, invoking the procedure for each.
void	forEachKeyValue(CharObjectProcedure<? super V> procedure) Iterates through each key/value pair in the map, invoking the procedure for each.
V	get(char key) Retrieves the value associated with the key.
V	getIfAbsent(char key, Function0<? extends V> ifAbsent) Retrieves the value associated with the key if one exists; if it does not, returns the result of invoking the value supplier.
default <IV> IV	injectIntoKeyValue(IV injectedValue, ObjectCharObjectToObjectFunction<? super IV,? super V,? extends IV> function) Implements the injectInto pattern with each key/value pair of the map.
MutableCharSet	keySet() Returns a set containing all the keys in this map.
LazyCharIterable	keysView() Returns a view of the keys in this map.
RichIterable<CharObjectPair<V>>	keyValuesView() Returns a view of the key/value pairs in this map.
CharObjectMap<V>	reject(CharObjectPredicate<? super V> predicate) Return a copy of this map containing only the key/value pairs that do not match the predicate.
CharObjectMap<V>	select(CharObjectPredicate<? super V> predicate) Return a copy of this map containing only the key/value pairs that match the predicate.
CharObjectMap<V>	tap(Procedure<? super V> procedure) Executes the Procedure for each element in the iterable and returns this.
ImmutableCharObjectMap<V>	toImmutable() Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.

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

collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsValue, equals, flatCollect, flatCollectWith, forEachValue, groupBy, groupByEach, groupByUniqueKey, hashCode, parallelStream, partition, partitionWith, reject, rejectWith, select, selectInstancesOf, selectWith, spliterator, stream, toString, values, zip, zipWithIndex

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

aggregateBy, aggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, count, countBy, countBy, countByEach, countByEach, countByWith, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getFirst, getLast, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

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

forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

get

V get(char key)

Retrieves the value associated with the key. If no mapping exists for the key, null is returned.

Parameters:

key - the key

Returns:

the value associated with the key, or the default value if no such mapping exists

getIfAbsent

V getIfAbsent(char key,
              Function0<? extends V> ifAbsent)

Retrieves the value associated with the key if one exists; if it does not, returns the result of invoking the value supplier.

Parameters:

key - the key

function - the supplier that provides the value if no mapping exists for key

Returns:

the value associated with the key, if one exists, or the result of invoking ifAbsent if not

containsKey

boolean containsKey(char key)

Returns whether or not the key is present in the map.

Parameters:

key - the key

Returns:

if a mapping exists in this map for the key

tap

CharObjectMap<V> tap(Procedure<? super V> procedure)

Description copied from interface: RichIterable

Executes the Procedure for each element in the iterable and returns this.

Example using a Java 8 lambda expression:

 RichIterable<Person> tapped =
     people.tap(person -> LOGGER.info(person.getName()));
 

Example using an anonymous inner class:

 RichIterable<Person> tapped =
     people.tap(new Procedure<Person>()
     {
         public void value(Person person)
         {
             LOGGER.info(person.getName());
         }
     });
 

Specified by:

tap in interface RichIterable<V>

See Also:

RichIterable.each(Procedure), RichIterable.forEach(Procedure)

forEachKey

void forEachKey(CharProcedure procedure)

Iterates through each key in the map, invoking the procedure for each.

Parameters:

procedure - the procedure to invoke for each key

forEachKeyValue

void forEachKeyValue(CharObjectProcedure<? super V> procedure)

Iterates through each key/value pair in the map, invoking the procedure for each.

Parameters:

procedure - the procedure to invoke for each key/value pair

injectIntoKeyValue

default <IV> IV injectIntoKeyValue(IV injectedValue,
                                   ObjectCharObjectToObjectFunction<? super IV,? super V,? extends IV> function)

Implements the injectInto pattern with each key/value pair of the map.

Parameters:

value - to be injected into the map

function - to apply to the injected value and key/value pairs

Returns:

result of injecting the injectedValue into the map

Since:

11.1

select

CharObjectMap<V> select(CharObjectPredicate<? super V> predicate)

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

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

CharObjectMap<V> reject(CharObjectPredicate<? super V> predicate)

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

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

toImmutable

ImmutableCharObjectMap<V> toImmutable()

Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.

Returns:

an immutable map that is equivalent to this one

keySet

MutableCharSet keySet()

Returns a set containing all the keys in this map. The set is backed by the map, so any modifications to the returned set will affect this map.

Returns:

a mutable set containing the keys in this map

keysView

LazyCharIterable keysView()

Returns a view of the keys in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the keys returned by the iterable.

Returns:

a view of the keys in this map

Since:

5.0

keyValuesView

RichIterable<CharObjectPair<V>> keyValuesView()

Returns a view of the key/value pairs in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the pairs returned by the iterable.

Returns:

a view of the keys in this map

Since:

5.0

flipUniqueValues

ObjectCharMap<V> flipUniqueValues()

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

Throws:

IllegalStateException - if the ObjectCharMap contains duplicate values.

Since:

9.0