Interface CharBooleanMap
- All Superinterfaces:
BooleanIterable
,BooleanValuesMap
,PrimitiveIterable
- All Known Subinterfaces:
ImmutableCharBooleanMap
,MutableCharBooleanMap
- All Known Implementing Classes:
CharBooleanHashMap
,SynchronizedCharBooleanMap
,UnmodifiableCharBooleanMap
public interface CharBooleanMap extends BooleanValuesMap
This file was automatically generated from template file primitivePrimitiveMap.stg.
- Since:
- 3.0.
-
Method Summary
Modifier and Type Method Description boolean
containsKey(char key)
Returns whether or not the key is present in the map.boolean
equals(Object o)
Follows the same general contract asMap.equals(Object)
.void
forEachKey(CharProcedure procedure)
Iterates through each key in the map, invoking the procedure for each.void
forEachKeyValue(CharBooleanProcedure procedure)
Iterates through each key/value pair in the map, invoking the procedure for each.boolean
get(char key)
Retrieves the value associated with the key.boolean
getIfAbsent(char key, boolean ifAbsent)
Retrieves the value associated with the key, returning the specified default value if no such mapping exists.boolean
getOrThrow(char key)
Retrieves the value associated with the key, throwing anIllegalStateException
if no such mapping exists.int
hashCode()
Follows the same general contract asMap.hashCode()
.MutableCharSet
keySet()
Returns a set containing all the keys in this map.LazyCharIterable
keysView()
Returns a view of the keys in this map.RichIterable<CharBooleanPair>
keyValuesView()
Returns a view of the key/value pairs in this map.CharBooleanMap
reject(CharBooleanPredicate predicate)
Return a copy of this map containing only the key/value pairs that do not match the predicate.CharBooleanMap
select(CharBooleanPredicate predicate)
Return a copy of this map containing only the key/value pairs that match the predicate.ImmutableCharBooleanMap
toImmutable()
Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.String
toString()
Follows the same general contract asAbstractMap.toString()
Methods inherited from interface org.eclipse.collections.api.BooleanIterable
allSatisfy, anySatisfy, asLazy, booleanIterator, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, contains, containsAll, containsAll, count, detectIfNone, each, flatCollect, forEach, injectInto, noneSatisfy, reduce, reduceIfEmpty, reject, select, toArray, toArray, toBag, toList, toSet
Methods inherited from interface org.eclipse.collections.api.map.primitive.BooleanValuesMap
collect, containsValue, forEachValue, reject, select, tap, values
Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable
appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size
-
Method Details
-
get
boolean get(char key)Retrieves the value associated with the key. If no mapping exists for the key, the default value (usually0
) is returned.- Parameters:
key
- the key- Returns:
- the value associated with the key, or the default value if no such mapping exists
-
getIfAbsent
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
- the keyifAbsent
- the default value to return if no mapping exists forkey
- Returns:
- the value associated with the key, or
ifAbsent
if no such mapping exists.
-
getOrThrow
boolean getOrThrow(char key)Retrieves the value associated with the key, throwing anIllegalStateException
if no such mapping exists.- Parameters:
key
- the key- Returns:
- the value associated with the key
- Throws:
IllegalStateException
- if no mapping exists for the key
-
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
-
forEachKey
Iterates through each key in the map, invoking the procedure for each.- Parameters:
procedure
- the procedure to invoke for each key
-
forEachKeyValue
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
-
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<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:
- a view of the keys in this map
- Since:
- 5.0
-
select
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
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
-
equals
Follows the same general contract asMap.equals(Object)
. -
hashCode
int hashCode()Follows the same general contract asMap.hashCode()
. -
toString
String toString()Follows the same general contract asAbstractMap.toString()
- Specified by:
toString
in interfacePrimitiveIterable
- Overrides:
toString
in classObject
- Returns:
- a string representation of this CharBooleanMap
- See Also:
AbstractCollection.toString()
-
toImmutable
ImmutableCharBooleanMap 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
-