Package org.eclipse.collections.impl.map.mutable.primitive

Class ByteIntHashMap

java.lang.Object

org.eclipse.collections.impl.primitive.AbstractIntIterable

org.eclipse.collections.impl.map.mutable.primitive.AbstractMutableIntValuesMap

org.eclipse.collections.impl.map.mutable.primitive.ByteIntHashMap

All Implemented Interfaces:

Externalizable, Serializable, IntIterable, ByteIntMap, IntValuesMap, MutableByteIntMap, MutableIntValuesMap, PrimitiveIterable, MutableByteKeysMap, ByteKeysMap

public class ByteIntHashMap
extends AbstractMutableIntValuesMap
implements MutableByteIntMap, Externalizable, MutableByteKeysMap

This file was automatically generated from template file primitivePrimitiveHashMap.stg.

Since:

3.0.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ByteIntHashMap()
ByteIntHashMap(int initialCapacity)
ByteIntHashMap(ByteIntMap map)

Method Summary

Modifier and Type	Method	Description
int	addToValue(byte key, int toBeAdded)	Increments and updates the value associated with the key, if a value exists, or sets the value to be the specified value if one does not.
MutableByteIntMap	asSynchronized()	Returns a synchronized view of this map, delegating all operations to this map but ensuring only one caller has access to the map at a time.
MutableByteIntMap	asUnmodifiable()	Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations.
void	clear()	Removes all entries from this map.
void	compact()	Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.
boolean	containsKey(byte key)	Returns whether or not the key is present in the map.
boolean	equals(Object obj)	Follows the same general contract as Map.equals(Object).
MutableIntByteMap	flipUniqueValues()	Return the IntByteMap 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(ByteIntProcedure procedure)	Iterates through each key/value pair in the map, invoking the procedure for each.
int	get(byte key)	Retrieves the value associated with the key.
int	getAndPut(byte key, int putValue, int defaultValue)	Retrieves the value associated with the key if one exists; associates a putValue with the key.
int	getIfAbsent(byte key, int ifAbsent)	Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
int	getIfAbsentPut(byte key, int value)	Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
int	getIfAbsentPut(byte key, IntFunction0 function)	Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.
<P> int	getIfAbsentPutWith(byte key, IntFunction<? super P> function, P parameter)	Retrieves the value associated with the key if one exists; if it does not, invokes the value function with the parameter and associates the result with the key.
int	getIfAbsentPutWithKey(byte key, ByteToIntFunction function)	Retrieves the value associated with the key if one exists; if it does not, associates the result of invoking the value function with the key.
int	getOrThrow(byte key)	Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.
int	hashCode()	Follows the same general contract as Map.hashCode().
<V> V	injectInto(V injectedValue, ObjectIntToObjectFunction<? super V,? extends V> function)
MutableIntIterator	intIterator()	Returns a primitive iterator that can be used to iterate over the IntIterable in an imperative style.
MutableByteSet	keySet()	Returns a set containing all the keys in this map.
LazyByteIterable	keysView()	Returns a view of the keys in this map.
RichIterable<ByteIntPair>	keyValuesView()	Returns a view of the key/value pairs in this map.
static ByteIntHashMap	newWithKeysValues(byte key1, int value1)
static ByteIntHashMap	newWithKeysValues(byte key1, int value1, byte key2, int value2)
static ByteIntHashMap	newWithKeysValues(byte key1, int value1, byte key2, int value2, byte key3, int value3)
static ByteIntHashMap	newWithKeysValues(byte key1, int value1, byte key2, int value2, byte key3, int value3, byte key4, int value4)
void	put(byte key, int value)	Associates a value with the specified key.
void	putAll(ByteIntMap map)	Puts all of the key/value mappings from the specified map into this map.
void	readExternal(ObjectInput in)
ByteIntHashMap	reject(ByteIntPredicate predicate)	Return a copy of this map containing only the key/value pairs that do not match the predicate.
void	remove(byte key)	Removes the mapping associated with the key, if one exists, from the map.
void	removeKey(byte key)	Removes the mapping associated with the key, if one exists, from the map.
int	removeKeyIfAbsent(byte key, int value)	Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
ByteIntHashMap	select(ByteIntPredicate predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
ImmutableByteIntMap	toImmutable()	Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.
String	toString()	Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.
int	updateValue(byte key, int initialValueIfAbsent, IntToIntFunction function)	Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or to the specified initial value if one does not.
void	updateValues(ByteIntToIntFunction function)	Updates the values in-place.
MutableIntCollection	values()	Returns the values in this map as a separate collection.
ByteIntHashMap	withKeysValues(byte key1, int value1, byte key2, int value2)
ByteIntHashMap	withKeysValues(byte key1, int value1, byte key2, int value2, byte key3, int value3)
ByteIntHashMap	withKeysValues(byte key1, int value1, byte key2, int value2, byte key3, int value3, byte key4, int value4)
ByteIntHashMap	withKeyValue(byte key1, int value1)	Associates a value with the specified key.
ByteIntHashMap	withoutAllKeys(ByteIterable keys)	Removes the mappings associated with all the keys, if they exist, from this map.
ByteIntHashMap	withoutKey(byte key)	Removes the mapping associated with the key, if one exists, from this map.
void	writeExternal(ObjectOutput out)

Methods inherited from class org.eclipse.collections.impl.map.mutable.primitive.AbstractMutableIntValuesMap

allSatisfy, anySatisfy, appendString, chunk, collect, contains, containsAll, containsValue, count, detectIfNone, each, forEachValue, isEmpty, max, min, notEmpty, reject, select, size, sum, toArray, toArray

Methods inherited from class org.eclipse.collections.impl.primitive.AbstractIntIterable

asLazy, average, maxIfEmpty, median, minIfEmpty, toBag, toList, toSet, toSortedArray, toSortedList

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.collections.api.map.primitive.ByteIntMap

injectIntoKeyValue

Methods inherited from interface org.eclipse.collections.impl.map.primitive.ByteKeysMap

isEmpty, notEmpty, size

Methods inherited from interface org.eclipse.collections.api.IntIterable

allSatisfy, anySatisfy, asLazy, average, averageIfEmpty, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, contains, containsAll, containsAll, containsAny, containsAny, containsNone, containsNone, count, detectIfNone, each, flatCollect, forEach, 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.IntValuesMap

containsValue, forEachValue, tap

Methods inherited from interface org.eclipse.collections.api.map.primitive.MutableByteIntMap

putPair, withAllKeyValues

Methods inherited from interface org.eclipse.collections.api.map.primitive.MutableIntValuesMap

collect, reject, select

Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable

appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size

Constructor Details

ByteIntHashMap

public ByteIntHashMap()

ByteIntHashMap

public ByteIntHashMap(int initialCapacity)

ByteIntHashMap

public ByteIntHashMap(ByteIntMap map)

Method Details

newWithKeysValues

public static ByteIntHashMap newWithKeysValues(byte key1,
 int value1)

newWithKeysValues

public static ByteIntHashMap newWithKeysValues(byte key1,
 int value1,
 byte key2,
 int value2)

newWithKeysValues

public static ByteIntHashMap newWithKeysValues(byte key1,
 int value1,
 byte key2,
 int value2,
 byte key3,
 int value3)

newWithKeysValues

public static ByteIntHashMap newWithKeysValues(byte key1,
 int value1,
 byte key2,
 int value2,
 byte key3,
 int value3,
 byte key4,
 int value4)

equals

public boolean equals(Object obj)

Description copied from interface: ByteIntMap

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

Specified by:

equals in interface ByteIntMap

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: ByteIntMap

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

Specified by:

hashCode in interface ByteIntMap

Overrides:

hashCode in class Object

toString

public String toString()

Description copied from interface: PrimitiveIterable

Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.

 Assert.assertEquals("[]", IntLists.mutable.empty().toString());
 Assert.assertEquals("[1]", IntLists.mutable.with(1).toString());
 Assert.assertEquals("[1, 2, 3]", IntLists.mutable.with(1, 2, 3).toString());
 

Specified by:

toString in interface ByteIntMap

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class AbstractIntIterable

Returns:

a string representation of this PrimitiveIterable

See Also:

• AbstractCollection.toString()

intIterator

public MutableIntIterator intIterator()

Description copied from interface: IntIterable

Returns a primitive iterator that can be used to iterate over the IntIterable in an imperative style.

Specified by:

intIterator in interface IntIterable

Specified by:

intIterator in interface MutableIntValuesMap

injectInto

public <V> V injectInto(V injectedValue,
 ObjectIntToObjectFunction<? super V,? extends V> function)

Specified by:

injectInto in interface IntIterable

clear

public void clear()

Description copied from interface: MutableIntValuesMap

Removes all entries from this map.

Specified by:

clear in interface MutableByteKeysMap

Specified by:

clear in interface MutableIntValuesMap

put

public void put(byte key,
 int value)

Description copied from interface: MutableByteIntMap

Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.

Specified by:

put in interface MutableByteIntMap

Parameters:

key - the key

value - the value to associate with value

putAll

public void putAll(ByteIntMap map)

Description copied from interface: MutableByteIntMap

Puts all of the key/value mappings from the specified map into this map. If this map already has a value associated with one of the keys in the map, it will be replaced with the value in map.

Specified by:

putAll in interface MutableByteIntMap

Parameters:

map - the map to copy into this map

updateValues

public void updateValues(ByteIntToIntFunction function)

Description copied from interface: MutableByteIntMap

Updates the values in-place.

Specified by:

updateValues in interface MutableByteIntMap

Parameters:

function - that takes a key and its value and that returns a new value for this key

removeKey

public void removeKey(byte key)

Description copied from interface: MutableByteIntMap

Removes the mapping associated with the key, if one exists, from the map.

Specified by:

removeKey in interface MutableByteIntMap

Specified by:

removeKey in interface MutableByteKeysMap

Parameters:

key - the key to remove

See Also:

• MutableByteIntMap.remove(byte)

remove

public void remove(byte key)

Description copied from interface: MutableByteIntMap

Removes the mapping associated with the key, if one exists, from the map.

Specified by:

remove in interface MutableByteIntMap

Parameters:

key - the key to remove

See Also:

• MutableByteIntMap.removeKey(byte)

removeKeyIfAbsent

public int removeKeyIfAbsent(byte key,
 int value)

Description copied from interface: MutableByteIntMap

Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key. If no mapping existed for the key, the specified default value is returned.

Specified by:

removeKeyIfAbsent in interface MutableByteIntMap

Parameters:

key - the key to remove

value - the default value to return if no mapping for the key exists

Returns:

the value previously associated with the key, if one existed, or value if not

getIfAbsentPut

public int getIfAbsentPut(byte key,
 int value)

Description copied from interface: MutableByteIntMap

Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.

Specified by:

getIfAbsentPut in interface MutableByteIntMap

Parameters:

key - the key

value - the value to associate with key if no such mapping exists

Returns:

the value associated with key, if one exists, or value if not

getAndPut

public int getAndPut(byte key,
 int putValue,
 int defaultValue)

Description copied from interface: MutableByteIntMap

Retrieves the value associated with the key if one exists; associates a putValue with the key.

Specified by:

getAndPut in interface MutableByteIntMap

Parameters:

key - the key

putValue - the value to associate with key if no such mapping exists

defaultValue - the value to return if no mapping associated with key exists

Returns:

the value associated with key, if one exists, or defaultValue if not

getIfAbsentPut

public int getIfAbsentPut(byte key,
 IntFunction0 function)

Description copied from interface: MutableByteIntMap

Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.

Specified by:

getIfAbsentPut in interface MutableByteIntMap

Parameters:

key - the key

function - the supplier that provides the value if no mapping exists for key

Returns:

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

getIfAbsentPutWith

public <P> int getIfAbsentPutWith(byte key,
 IntFunction<? super P> function,
 P parameter)

Description copied from interface: MutableByteIntMap

Retrieves the value associated with the key if one exists; if it does not, invokes the value function with the parameter and associates the result with the key.

Specified by:

getIfAbsentPutWith in interface MutableByteIntMap

Type Parameters:

P - the type of the value function's parameter

Parameters:

key - the key

function - the function that provides the value if no mapping exists. The specified parameter will be passed as the argument to the function.

parameter - the parameter to provide to function if no value exists for key

Returns:

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

getIfAbsentPutWithKey

public int getIfAbsentPutWithKey(byte key,
 ByteToIntFunction function)

Description copied from interface: MutableByteIntMap

Retrieves the value associated with the key if one exists; if it does not, associates the result of invoking the value function with the key.

Specified by:

getIfAbsentPutWithKey in interface MutableByteIntMap

Parameters:

key - the key

function - the function that provides the value if no mapping exists. The key will be passed as the argument to the function.

Returns:

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

addToValue

public int addToValue(byte key,
 int toBeAdded)

Description copied from interface: MutableByteIntMap

Increments and updates the value associated with the key, if a value exists, or sets the value to be the specified value if one does not.

Specified by:

addToValue in interface MutableByteIntMap

Parameters:

key - the key

toBeAdded - the amount to increment the existing value, if one exists, or to use as the initial value if one does not

Returns:

the value after incrementing toBeAdded to the existing value associated with key or toBeAdded if one does not

updateValue

public int updateValue(byte key,
 int initialValueIfAbsent,
 IntToIntFunction function)

Description copied from interface: MutableByteIntMap

Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or to the specified initial value if one does not.

Specified by:

updateValue in interface MutableByteIntMap

Parameters:

key - the key

initialValueIfAbsent - the initial value to supply to the function if no mapping exists for the key

function - the function that returns the updated value based on the current value or the initial value, if no value exists

Returns:

the new value associated with the key, either as a result of applying function to the value already associated with the key or as a result of applying it to initialValueIfAbsent and associating the result with key

withKeyValue

public ByteIntHashMap withKeyValue(byte key1,
 int value1)

Description copied from interface: MutableByteIntMap

Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.

Specified by:

withKeyValue in interface MutableByteIntMap

Parameters:

key1 - the key

value1 - the value to associate with value

Returns:

this map

See Also:

• MutableByteIntMap.put(byte, int)

withKeysValues

public ByteIntHashMap withKeysValues(byte key1,
 int value1,
 byte key2,
 int value2)

withKeysValues

public ByteIntHashMap withKeysValues(byte key1,
 int value1,
 byte key2,
 int value2,
 byte key3,
 int value3)

withKeysValues

public ByteIntHashMap withKeysValues(byte key1,
 int value1,
 byte key2,
 int value2,
 byte key3,
 int value3,
 byte key4,
 int value4)

withoutKey

public ByteIntHashMap withoutKey(byte key)

Description copied from interface: MutableByteIntMap

Removes the mapping associated with the key, if one exists, from this map.

Specified by:

withoutKey in interface MutableByteIntMap

Parameters:

key - the key to remove

Returns:

this map

See Also:

• MutableByteIntMap.remove(byte)

withoutAllKeys

public ByteIntHashMap withoutAllKeys(ByteIterable keys)

Description copied from interface: MutableByteIntMap

Removes the mappings associated with all the keys, if they exist, from this map.

Specified by:

withoutAllKeys in interface MutableByteIntMap

Parameters:

keys - the keys to remove

Returns:

this map

See Also:

• MutableByteIntMap.remove(byte)

asUnmodifiable

public MutableByteIntMap asUnmodifiable()

Description copied from interface: MutableByteIntMap

Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations. This avoids the overhead of copying the map when calling ByteIntMap.toImmutable() while still providing immutability.

Specified by:

asUnmodifiable in interface MutableByteIntMap

Returns:

an unmodifiable view of this map

asSynchronized

public MutableByteIntMap asSynchronized()

Description copied from interface: MutableByteIntMap

Returns a synchronized view of this map, delegating all operations to this map but ensuring only one caller has access to the map at a time.

Specified by:

asSynchronized in interface MutableByteIntMap

Returns:

a synchronized view of this map

toImmutable

public ImmutableByteIntMap toImmutable()

Description copied from interface: ByteIntMap

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

Specified by:

toImmutable in interface ByteIntMap

Returns:

an immutable map that is equivalent to this one

get

public int get(byte key)

Description copied from interface: ByteIntMap

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

Specified by:

get in interface ByteIntMap

Parameters:

key - the key

Returns:

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

getIfAbsent

public int getIfAbsent(byte key,
 int ifAbsent)

Description copied from interface: ByteIntMap

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

Specified by:

getIfAbsent in interface ByteIntMap

Parameters:

key - the key

ifAbsent - the default value to return if no mapping exists for key

Returns:

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

getOrThrow

public int getOrThrow(byte key)

Description copied from interface: ByteIntMap

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

Specified by:

getOrThrow in interface ByteIntMap

Parameters:

key - the key

Returns:

the value associated with the key

containsKey

public boolean containsKey(byte key)

Description copied from interface: ByteIntMap

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

Specified by:

containsKey in interface ByteIntMap

Specified by:

containsKey in interface ByteKeysMap

Parameters:

key - the key

Returns:

if a mapping exists in this map for the key

forEachKey

public void forEachKey(ByteProcedure procedure)

Description copied from interface: ByteIntMap

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

Specified by:

forEachKey in interface ByteIntMap

Specified by:

forEachKey in interface ByteKeysMap

Parameters:

procedure - the procedure to invoke for each key

forEachKeyValue

public void forEachKeyValue(ByteIntProcedure procedure)

Description copied from interface: ByteIntMap

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

Specified by:

forEachKeyValue in interface ByteIntMap

Parameters:

procedure - the procedure to invoke for each key/value pair

keysView

public LazyByteIterable keysView()

Description copied from interface: ByteIntMap

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.

Specified by:

keysView in interface ByteIntMap

Returns:

a view of the keys in this map

keyValuesView

public RichIterable<ByteIntPair> keyValuesView()

Description copied from interface: ByteIntMap

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.

Specified by:

keyValuesView in interface ByteIntMap

Returns:

a view of the keys in this map

flipUniqueValues

public MutableIntByteMap flipUniqueValues()

Description copied from interface: ByteIntMap

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

Specified by:

flipUniqueValues in interface ByteIntMap

Specified by:

flipUniqueValues in interface MutableByteIntMap

select

public ByteIntHashMap select(ByteIntPredicate predicate)

Description copied from interface: ByteIntMap

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

Specified by:

select in interface ByteIntMap

Specified by:

select in interface MutableByteIntMap

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

public ByteIntHashMap reject(ByteIntPredicate predicate)

Description copied from interface: ByteIntMap

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

Specified by:

reject in interface ByteIntMap

Specified by:

reject in interface MutableByteIntMap

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

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

compact

public void compact()

Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.

keySet

public MutableByteSet keySet()

Description copied from interface: ByteIntMap

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.

Specified by:

keySet in interface ByteIntMap

Returns:

a mutable set containing the keys in this map

values

public MutableIntCollection values()

Description copied from interface: IntValuesMap

Returns the values in this map as a separate collection. The returned collection is backed by the map, so any changes made to the returned collection will affect the state of this map.

Specified by:

values in interface IntValuesMap

Returns:

the values as a collection backed by this map