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

public Interface CharBooleanMap

extends BooleanValuesMap
Known Direct Subinterfaces
org.eclipse.collections.api.map.primitive.ImmutableCharBooleanMap, org.eclipse.collections.api.map.primitive.MutableCharBooleanMap
Imports
java.util.Map, org.eclipse.collections.api.LazyCharIterable, .RichIterable, org.eclipse.collections.api.block.predicate.primitive.CharBooleanPredicate, org.eclipse.collections.api.block.procedure.primitive.CharBooleanProcedure, .CharProcedure, org.eclipse.collections.api.block.function.primitive.ObjectCharBooleanToObjectFunction, org.eclipse.collections.api.set.primitive.MutableCharSet, org.eclipse.collections.api.tuple.primitive.CharBooleanPair

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

Method Summary

Modifier and TypeMethod and Description
public default boolean
public boolean

Returns:

if a mapping exists in this map for the key
containsKey
(char
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 void
forEachKey(CharProcedure
the procedure to invoke for each key
procedure
)

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

public void
forEachKeyValue(CharBooleanProcedure
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 boolean

Returns:

the value associated with the key, or the default value if no such mapping exists
get
(char
the key
key
)

Retrieves the value associated with the key.

public boolean

Returns:

the value associated with the key, or ifAbsent if no such mapping exists.
getIfAbsent
(char
the key
key
,
boolean
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 boolean

Returns:

the value associated with the key
getOrThrow
(char
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
,
ObjectCharBooleanToObjectFunction<? 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 MutableCharSet

Returns:

a mutable set containing the keys in this map
keySet
()

Returns a set containing all the keys in this map.

public LazyCharIterable

Returns:

a view of the keys in this map
keysView
()

Returns a view of the keys in this map.

public RichIterable<CharBooleanPair>

Returns:

a view of the keys in this map
keyValuesView
()

Returns a view of the key/value pairs in this map.

public CharBooleanMap

Returns:

a copy of this map without the matching key/value pairs
reject
(CharBooleanPredicate
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 CharBooleanMap

Returns:

a copy of this map with the matching key/value pairs
select
(CharBooleanPredicate
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 ImmutableCharBooleanMap

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 CharBooleanMap
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.BooleanValuesMap:
collectcontainsValueforEachValuerejectselecttapvalues

Method Detail

allSatisfyKeyValueback to summary
public default boolean allSatisfyKeyValue(CharBooleanPredicate predicate)
Since
12.0
containsKeyback to summary
public boolean containsKey(char key)

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

Parameters
key:char

the key

Returns:boolean

if a mapping exists in this map for the key

equalsback to summary
public boolean equals(Object o)

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

Annotations
@Override
forEachKeyback to summary
public void forEachKey(CharProcedure procedure)

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

Parameters
procedure:CharProcedure

the procedure to invoke for each key

forEachKeyValueback to summary
public void forEachKeyValue(CharBooleanProcedure procedure)

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

Parameters
procedure:CharBooleanProcedure

the procedure to invoke for each key/value pair

getback to summary
public boolean get(char key)

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

Parameters
key:char

the key

Returns:boolean

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

getIfAbsentback to summary
public boolean getIfAbsent(char key, boolean ifAbsent)

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

Parameters
key:char

the key

ifAbsent:boolean

the default value to return if no mapping exists for key

Returns:boolean

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

getOrThrowback to summary
public boolean getOrThrow(char key)

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

Parameters
key:char

the key

Returns:boolean

the value associated with the key

Exceptions
IllegalStateException:
if no mapping exists for the key
hashCodeback to summary
public int hashCode()

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

Annotations
@Override
injectIntoKeyValueback to summary
public default <IV> IV injectIntoKeyValue(IV injectedValue, ObjectCharBooleanToObjectFunction<? 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:ObjectCharBooleanToObjectFunction<? 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
keySetback to summary
public 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:MutableCharSet

a mutable set containing the keys in this map

keysViewback to summary
public 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:LazyCharIterable

a view of the keys in this map

Since
5.0
keyValuesViewback to summary
public RichIterable<CharBooleanPair> 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<CharBooleanPair>

a view of the keys in this map

Since
5.0
rejectback to summary
public CharBooleanMap reject(CharBooleanPredicate predicate)

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

Parameters
predicate:CharBooleanPredicate

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

Returns:CharBooleanMap

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

selectback to summary
public CharBooleanMap select(CharBooleanPredicate predicate)

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

Parameters
predicate:CharBooleanPredicate

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

Returns:CharBooleanMap

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

toImmutableback to summary
public ImmutableCharBooleanMap toImmutable()

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

Returns:ImmutableCharBooleanMap

an immutable map that is equivalent to this one

toStringback 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 CharBooleanMap

Annotations
@Override