Eclipse Collections 13.0.0 · org.eclipse.collections.api.map.primitive.IntObjectMap

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: if a mapping exists in this map for the key containsKey(int the key key) Returns whether or not the key is present in the map.
public ObjectIntMap<V>	flipUniqueValues() Return the ObjectIntMap that is obtained by flipping the direction of this map and making the associations from value to key.
public void	forEachKey(IntProcedure the procedure to invoke for each key procedure) Iterates through each key in the map, invoking the procedure for each.
public void	forEachKeyValue(IntObjectProcedure<? super V> the procedure to invoke for each key/value pair procedure) Iterates through each key/value pair in the map, invoking the procedure for each.
public V	Returns: the value associated with the key, or the default value if no such mapping exists get(int the key key) Retrieves the value associated with the key.
public V	Returns: the value associated with the key, if one exists, or the result of invoking `ifAbsent` if not getIfAbsent(int the key 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.
public default <IV> IV	Returns: result of injecting the injectedValue into the map injectIntoKeyValue(IV value to be injected into the map injectedValue, ObjectIntObjectToObjectFunction<? super IV, ? super V, ? extends IV> to apply to the injected value and key/value pairs function) Implements the injectInto pattern with each key/value pair of the map.
public MutableIntSet	Returns: a mutable set containing the keys in this map keySet() Returns a set containing all the keys in this map.
public LazyIntIterable	Returns: a view of the keys in this map keysView() Returns a view of the keys in this map.
public RichIterable<IntObjectPair<V>>	Returns: a view of the keys in this map keyValuesView() Returns a view of the key/value pairs in this map.
public IntObjectMap<V>	Returns: a copy of this map without the matching key/value pairs reject(IntObjectPredicate<? super V> the predicate to determine which key/value pairs in this map should be excluded from the returned map predicate) Return a copy of this map containing only the key/value pairs that do not match the predicate.
public IntObjectMap<V>	Returns: a copy of this map with the matching key/value pairs select(IntObjectPredicate<? super V> the predicate to determine which key/value pairs in this map should be included in the returned map predicate) Return a copy of this map containing only the key/value pairs that match the predicate.
public IntObjectMap<V>	tap(Procedure<? super V> procedure) Redeclares org.eclipse.collections.api.RichIterable.tap. Executes the Procedure for each element in the iterable and returns `this`.
public ImmutableIntObjectMap<V>	Returns: an immutable map that is equivalent to this one toImmutable() Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.

Method Detail

containsKey	back to summary
public boolean containsKey(int key) Returns whether or not the key is present in the map. Parameters key:int the key Returns:boolean if a mapping exists in this map for the key

containsKey

back to summary

public boolean containsKey(int key)

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

Parameters

key:int: the key

Returns:boolean

if a mapping exists in this map for the key

flipUniqueValues	back to summary
public ObjectIntMap<V> flipUniqueValues() Return the ObjectIntMap that is obtained by flipping the direction of this map and making the associations from value to key. Exceptions IllegalStateException: if the ObjectIntMap contains duplicate values. Since 9.0

flipUniqueValues

back to summary

public ObjectIntMap<V> flipUniqueValues()

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

Exceptions

IllegalStateException:: if the ObjectIntMap contains duplicate values.

Since

9.0

forEachKey	back to summary
public void forEachKey(IntProcedure procedure) Iterates through each key in the map, invoking the procedure for each. Parameters procedure:IntProcedure the procedure to invoke for each key

forEachKey

back to summary

public void forEachKey(IntProcedure procedure)

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

Parameters

procedure:IntProcedure: the procedure to invoke for each key

forEachKeyValue	back to summary
public void forEachKeyValue(IntObjectProcedure<? super V> procedure) Iterates through each key/value pair in the map, invoking the procedure for each. Parameters procedure:IntObjectProcedure<? super V> the procedure to invoke for each key/value pair

forEachKeyValue

back to summary

public void forEachKeyValue(IntObjectProcedure<? super V> procedure)

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

Parameters

procedure:IntObjectProcedure<? super V>: the procedure to invoke for each key/value pair

get back to summary

get	back to summary
public V get(int key) Retrieves the value associated with the key. If no mapping exists for the key, `null` is returned. Parameters key:int the key Returns:V the value associated with the key, or the default value if no such mapping exists

public V get(int key)

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

Parameters

key:int: the key

Returns:V

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

getIfAbsent back to summary

getIfAbsent	back to summary
public V getIfAbsent(int 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:int the key Returns:V the value associated with the key, if one exists, or the result of invoking `ifAbsent` if not

public V getIfAbsent(int 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:int: the key

Returns:V

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

injectIntoKeyValue	back to summary
public default <IV> IV injectIntoKeyValue(IV injectedValue, ObjectIntObjectToObjectFunction<? super IV, ? super V, ? extends IV> function) Implements the injectInto pattern with each key/value pair of the map. Parameters injectedValue:IV value to be injected into the map function:ObjectIntObjectToObjectFunction<? super IV, ? super V, ? extends IV> to apply to the injected value and key/value pairs Returns:IV result of injecting the injectedValue into the map Since 11.1

injectIntoKeyValue

back to summary

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

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

Parameters

injectedValue:IV: value to be injected into the map
function:ObjectIntObjectToObjectFunction<? super IV, ? super V, ? extends IV>: to apply to the injected value and key/value pairs

Returns:IV

result of injecting the injectedValue into the map

Since

11.1

keySet	back to summary
public MutableIntSet 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:MutableIntSet a mutable set containing the keys in this map

keySet

back to summary

public MutableIntSet 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:MutableIntSet: a mutable set containing the keys in this map

keysView	back to summary
public LazyIntIterable 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:LazyIntIterable a view of the keys in this map Since 5.0

keysView

back to summary

public LazyIntIterable 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:LazyIntIterable: a view of the keys in this map
Since: 5.0

keyValuesView	back to summary
public RichIterable<IntObjectPair<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:RichIterable<IntObjectPair<V>> a view of the keys in this map Since 5.0

keyValuesView

back to summary

public RichIterable<IntObjectPair<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:RichIterable<IntObjectPair<V>>: a view of the keys in this map
Since: 5.0

reject	back to summary
public IntObjectMap<V> reject(IntObjectPredicate<? super V> predicate) Return a copy of this map containing only the key/value pairs that do not match the predicate. Parameters predicate:IntObjectPredicate<? super V> the predicate to determine which key/value pairs in this map should be excluded from the returned map Returns:IntObjectMap<V> a copy of this map without the matching key/value pairs

reject

back to summary

public IntObjectMap<V> reject(IntObjectPredicate<? super V> predicate)

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

Parameters

predicate:IntObjectPredicate<? super V>: the predicate to determine which key/value pairs in this map should be excluded from the returned map

Returns:IntObjectMap<V>

a copy of this map without the matching key/value pairs

select	back to summary
public IntObjectMap<V> select(IntObjectPredicate<? super V> predicate) Return a copy of this map containing only the key/value pairs that match the predicate. Parameters predicate:IntObjectPredicate<? super V> the predicate to determine which key/value pairs in this map should be included in the returned map Returns:IntObjectMap<V> a copy of this map with the matching key/value pairs

select

back to summary

public IntObjectMap<V> select(IntObjectPredicate<? super V> predicate)

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

Parameters

predicate:IntObjectPredicate<? super V>: the predicate to determine which key/value pairs in this map should be included in the returned map

Returns:IntObjectMap<V>

a copy of this map with the matching key/value pairs

tap back to summary

tap	back to summary
public IntObjectMap<V> tap(Procedure<? super V> procedure) Redeclares org.eclipse.collections.api.RichIterable.tap. Doc from org.eclipse.collections.api.RichIterable.tap. 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())); Annotations @Override

public IntObjectMap<V> tap(Procedure<? super V> procedure)

Redeclares org.eclipse.collections.api.RichIterable.tap.

Doc from org.eclipse.collections.api.RichIterable.tap.

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()));

Annotations

@Override

toImmutable	back to summary
public ImmutableIntObjectMap<V> toImmutable() Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable. Returns:ImmutableIntObjectMap<V> an immutable map that is equivalent to this one

toImmutable

back to summary

public ImmutableIntObjectMap<V> toImmutable()

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

Returns:ImmutableIntObjectMap<V>: an immutable map that is equivalent to this one

public Interface IntObjectMap<V>

Method Summary

Method Detail