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

Method Summary

Modifier and Type	Method and Description
public default boolean	allSatisfyKeyValue(ShortCharPredicate predicate)
public boolean	Returns: if a mapping exists in this map for the key containsKey(short the key key) Returns whether or not the key is present in the map.
public boolean	equals(Object o) Follows the same general contract as `Map#equals(Object)`.
public CharShortMap	flipUniqueValues() Return the CharShortMap that is obtained by flipping the direction of this map and making the associations from value to key.
public void	forEachKey(ShortProcedure the procedure to invoke for each key procedure) Iterates through each key in the map, invoking the procedure for each.
public void	forEachKeyValue(ShortCharProcedure 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 char	Returns: the value associated with the key, or the default value if no such mapping exists get(short the key key) Retrieves the value associated with the key.
public char	Returns: the value associated with the key, or `ifAbsent` if no such mapping exists. getIfAbsent(short the key key, char the default value to return if no mapping exists for `key` ifAbsent) Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
public char	Returns: the value associated with the key getOrThrow(short the key key) Retrieves the value associated with the key, throwing an `IllegalStateException` if no such mapping exists.
public int	hashCode() Follows the same general contract as `Map#hashCode()`.
public default <IV> IV	Returns: result of injecting the injectedValue into the map injectIntoKeyValue(IV value to be injected into the map injectedValue, ObjectShortCharToObjectFunction<? super IV, ? 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 MutableShortSet	Returns: a mutable set containing the keys in this map keySet() Returns a set containing all the keys in this map.
public LazyShortIterable	Returns: a view of the keys in this map keysView() Returns a view of the keys in this map.
public RichIterable<ShortCharPair>	Returns: a view of the keys in this map keyValuesView() Returns a view of the key/value pairs in this map.
public ShortCharMap	Returns: a copy of this map without the matching key/value pairs reject(ShortCharPredicate 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 ShortCharMap	Returns: a copy of this map with the matching key/value pairs select(ShortCharPredicate 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 ImmutableShortCharMap	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.
public String	Returns: a string representation of this ShortCharMap toString() Redeclares org.eclipse.collections.api.PrimitiveIterable.toString. Follows the same general contract as `java.util.AbstractMap#toString()`

Inherited from org.eclipse.collections.api.map.primitive.CharValuesMap:: collect containsValue forEachValue reject select tap values

Method Detail

allSatisfyKeyValue	back to summary
public default boolean allSatisfyKeyValue(ShortCharPredicate predicate) Since 12.0

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

containsKey

back to summary

public boolean containsKey(short key)

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

Parameters

key:short: the key

Returns:boolean

if a mapping exists in this map for the key

equals back to summary

equals	back to summary
public boolean equals(Object o) Follows the same general contract as `Map#equals(Object)`. Annotations @Override

public boolean equals(Object o)

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

Annotations

@Override

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

flipUniqueValues

back to summary

public CharShortMap flipUniqueValues()

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

Exceptions

IllegalStateException:: if the CharShortMap contains duplicate values.

Since

9.0

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

forEachKey

back to summary

public void forEachKey(ShortProcedure procedure)

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

Parameters

procedure:ShortProcedure: the procedure to invoke for each key

forEachKeyValue	back to summary
public void forEachKeyValue(ShortCharProcedure procedure) Iterates through each key/value pair in the map, invoking the procedure for each. Parameters procedure:ShortCharProcedure the procedure to invoke for each key/value pair

forEachKeyValue

back to summary

public void forEachKeyValue(ShortCharProcedure procedure)

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

Parameters

procedure:ShortCharProcedure: the procedure to invoke for each key/value pair

get back to summary

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

public char get(short key)

Retrieves the value associated with the key. If no mapping exists for the key, the default value (usually 0) is returned.

Parameters

key:short: the key

Returns:char

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

getIfAbsent back to summary

getIfAbsent	back to summary
public char getIfAbsent(short key, char ifAbsent) Retrieves the value associated with the key, returning the specified default value if no such mapping exists. Parameters key:short the key ifAbsent:char the default value to return if no mapping exists for `key` Returns:char the value associated with the key, or `ifAbsent` if no such mapping exists.

public char getIfAbsent(short key, char ifAbsent)

Retrieves the value associated with the key, returning the specified default value if no such mapping exists.

Parameters

key:short: the key
ifAbsent:char: the default value to return if no mapping exists for key

Returns:char

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

getOrThrow back to summary

getOrThrow	back to summary
public char getOrThrow(short key) Retrieves the value associated with the key, throwing an `IllegalStateException` if no such mapping exists. Parameters key:short the key Returns:char the value associated with the key Exceptions IllegalStateException: if no mapping exists for the key

public char getOrThrow(short key)

Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.

Parameters

key:short: the key

Returns:char

the value associated with the key

Exceptions

IllegalStateException:: if no mapping exists for the key

hashCode back to summary

hashCode	back to summary
public int hashCode() Follows the same general contract as `Map#hashCode()`. Annotations @Override

public int hashCode()

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

Annotations

@Override

injectIntoKeyValue	back to summary
public default <IV> IV injectIntoKeyValue(IV injectedValue, ObjectShortCharToObjectFunction<? super IV, ? 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:ObjectShortCharToObjectFunction<? super IV, ? 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, ObjectShortCharToObjectFunction<? super IV, ? 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:ObjectShortCharToObjectFunction<? super IV, ? 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 MutableShortSet 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:MutableShortSet a mutable set containing the keys in this map

keySet

back to summary

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

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

keysView

back to summary

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

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

keyValuesView

back to summary

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

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

reject

back to summary

public ShortCharMap reject(ShortCharPredicate predicate)

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

Parameters

predicate:ShortCharPredicate: the predicate to determine which key/value pairs in this map should be excluded from the returned map

Returns:ShortCharMap

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

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

select

back to summary

public ShortCharMap select(ShortCharPredicate predicate)

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

Parameters

predicate:ShortCharPredicate: the predicate to determine which key/value pairs in this map should be included in the returned map

Returns:ShortCharMap

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

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

toImmutable

back to summary

public ImmutableShortCharMap toImmutable()

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

Returns:ImmutableShortCharMap: an immutable map that is equivalent to this one

toString back to summary

toString	back to summary
public String toString() Redeclares org.eclipse.collections.api.PrimitiveIterable.toString. Follows the same general contract as `java.util.AbstractMap#toString()` Returns:String a string representation of this ShortCharMap Annotations @Override

public String toString()

Redeclares org.eclipse.collections.api.PrimitiveIterable.toString.

Follows the same general contract as java.util.AbstractMap#toString()

Returns:String

a string representation of this ShortCharMap

Annotations

@Override

public Interface ShortCharMap

Method Summary

Method Detail