Interface ByteByteMap
-
- All Superinterfaces:
ByteIterable
,ByteValuesMap
,PrimitiveIterable
- All Known Subinterfaces:
ImmutableByteByteMap
,MutableByteByteMap
- All Known Implementing Classes:
ByteByteHashMap
,ImmutableByteByteEmptyMap
,ImmutableByteByteHashMap
,ImmutableByteByteSingletonMap
,SynchronizedByteByteMap
,UnmodifiableByteByteMap
public interface ByteByteMap extends ByteValuesMap
This file was automatically generated from template file primitivePrimitiveMap.stg.- Since:
- 3.0.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description boolean
containsKey(byte key)
Returns whether or not the key is present in the map.boolean
equals(java.lang.Object o)
Follows the same general contract asMap.equals(Object)
.ByteByteMap
flipUniqueValues()
Return the ByteByteMap that is obtained by flipping the direction of this map and making the associations from value to key.void
forEachKey(ByteProcedure procedure)
Iterates through each key in the map, invoking the procedure for each.void
forEachKeyValue(ByteByteProcedure procedure)
Iterates through each key/value pair in the map, invoking the procedure for each.byte
get(byte key)
Retrieves the value associated with the key.byte
getIfAbsent(byte key, byte ifAbsent)
Retrieves the value associated with the key, returning the specified default value if no such mapping exists.byte
getOrThrow(byte key)
Retrieves the value associated with the key, throwing anIllegalStateException
if no such mapping exists.int
hashCode()
Follows the same general contract asMap.hashCode()
.default <IV> IV
injectIntoKeyValue(IV injectedValue, ObjectByteByteToObjectFunction<? super IV,? extends IV> function)
Implements the injectInto pattern with each key/value pair of the map.MutableByteSet
keySet()
Returns a set containing all the keys in this map.LazyByteIterable
keysView()
Returns a view of the keys in this map.RichIterable<ByteBytePair>
keyValuesView()
Returns a view of the key/value pairs in this map.ByteByteMap
reject(ByteBytePredicate predicate)
Return a copy of this map containing only the key/value pairs that do not match the predicate.ByteByteMap
select(ByteBytePredicate predicate)
Return a copy of this map containing only the key/value pairs that match the predicate.ImmutableByteByteMap
toImmutable()
Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.java.lang.String
toString()
Follows the same general contract asAbstractMap.toString()
-
Methods inherited from interface org.eclipse.collections.api.ByteIterable
allSatisfy, anySatisfy, asLazy, average, averageIfEmpty, byteIterator, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, contains, containsAll, containsAll, containsAny, containsAny, containsNone, containsNone, count, detectIfNone, each, flatCollect, forEach, injectInto, injectIntoBoolean, injectIntoByte, injectIntoChar, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, injectIntoShort, max, maxIfEmpty, median, medianIfEmpty, min, minIfEmpty, noneSatisfy, reduce, reduceIfEmpty, reject, select, sum, summaryStatistics, toArray, toArray, toBag, toList, toSet, toSortedArray, toSortedList, toSortedList, toSortedListBy, toSortedListBy
-
Methods inherited from interface org.eclipse.collections.api.map.primitive.ByteValuesMap
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 Detail
-
get
byte get(byte 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
byte getIfAbsent(byte key, byte 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
byte getOrThrow(byte 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:
java.lang.IllegalStateException
- if no mapping exists for the key
-
containsKey
boolean containsKey(byte 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
void forEachKey(ByteProcedure 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(ByteByteProcedure 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, ObjectByteByteToObjectFunction<? super IV,? extends IV> function)
Implements the injectInto pattern with each key/value pair of the map.- Parameters:
value
- to be injected into the mapfunction
- to apply to the injected value and key/value pairs- Returns:
- result of injecting the injectedValue into the map
- Since:
- 11.1
-
keysView
LazyByteIterable 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<ByteBytePair> 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
ByteByteMap flipUniqueValues()
Return the ByteByteMap that is obtained by flipping the direction of this map and making the associations from value to key.- Throws:
java.lang.IllegalStateException
- if the ByteByteMap contains duplicate values.- Since:
- 9.0
-
select
ByteByteMap select(ByteBytePredicate 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
ByteByteMap reject(ByteBytePredicate 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
-
equals
boolean equals(java.lang.Object o)
Follows the same general contract asMap.equals(Object)
.- Overrides:
equals
in classjava.lang.Object
-
hashCode
int hashCode()
Follows the same general contract asMap.hashCode()
.- Overrides:
hashCode
in classjava.lang.Object
-
toString
java.lang.String toString()
Follows the same general contract asAbstractMap.toString()
- Specified by:
toString
in interfacePrimitiveIterable
- Overrides:
toString
in classjava.lang.Object
- Returns:
- a string representation of this ByteByteMap
- See Also:
AbstractCollection.toString()
-
toImmutable
ImmutableByteByteMap 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
MutableByteSet 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
-
-