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

Class UnmodifiableFloatShortMap

java.lang.Object

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

All Implemented Interfaces:

Serializable, FloatShortMap, MutableFloatShortMap, MutableShortValuesMap, ShortValuesMap, PrimitiveIterable, ShortIterable

public class UnmodifiableFloatShortMap
extends Object
implements MutableFloatShortMap, Serializable

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

Since:

3.1.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
UnmodifiableFloatShortMap(MutableFloatShortMap map)

Method Summary

Modifier and Type	Method	Description
short	addToValue(float key, short 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.
boolean	allSatisfy(ShortPredicate predicate)	Returns true if all of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
boolean	anySatisfy(ShortPredicate predicate)	Returns true if any of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
void	appendString(Appendable appendable)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String separator)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String start, String separator, String end)	Prints a string representation of this collection onto the given Appendable.
LazyShortIterable	asLazy()	Returns a LazyShortIterable adapter wrapping the source ShortIterable.
MutableFloatShortMap	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.
MutableFloatShortMap	asUnmodifiable()	Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations.
double	average()
RichIterable<ShortIterable>	chunk(int size)	Partitions elements in fixed size chunks.
void	clear()	Removes all entries from this map.
<V> MutableBag<V>	collect(ShortToObjectFunction<? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
boolean	contains(short value)	Returns true if the value is contained in the ShortIterable, and false if it is not.
boolean	containsAll(short... source)	Returns true if all of the values specified in the source array are contained in the ShortIterable, and false if they are not.
boolean	containsAll(ShortIterable source)	Returns true if all of the values specified in the source ShortIterable are contained in the ShortIterable, and false if they are not.
boolean	containsKey(float key)	Returns whether or not the key is present in the map.
boolean	containsValue(short value)	Returns whether or not this map contains the value.
int	count(ShortPredicate predicate)	Returns a count of the number of elements in the ShortIterable that return true for the specified predicate.
short	detectIfNone(ShortPredicate predicate, short ifNone)
void	each(ShortProcedure procedure)	A synonym for forEach.
boolean	equals(Object otherMap)	Follows the same general contract as Map.equals(Object).
MutableShortFloatMap	flipUniqueValues()	Return the ShortFloatMap that is obtained by flipping the direction of this map and making the associations from value to key.
void	forEachKey(FloatProcedure procedure)	Iterates through each key in the map, invoking the procedure for each.
void	forEachKeyValue(FloatShortProcedure procedure)	Iterates through each key/value pair in the map, invoking the procedure for each.
void	forEachValue(ShortProcedure procedure)	Iterates through each value in this map.
short	get(float key)	Retrieves the value associated with the key.
short	getAndPut(float key, short putValue, short defaultValue)	Retrieves the value associated with the key if one exists; associates a putValue with the key.
short	getIfAbsent(float key, short ifAbsent)	Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
short	getIfAbsentPut(float key, short value)	Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
short	getIfAbsentPut(float key, ShortFunction0 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> short	getIfAbsentPutWith(float key, ShortFunction<? 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.
short	getIfAbsentPutWithKey(float key, FloatToShortFunction 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.
short	getOrThrow(float 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().
<T> T	injectInto(T injectedValue, ObjectShortToObjectFunction<? super T,? extends T> function)
boolean	isEmpty()	Returns true if this iterable has zero items.
MutableFloatSet	keySet()	Returns a set containing all the keys in this map.
LazyFloatIterable	keysView()	Returns a view of the keys in this map.
RichIterable<FloatShortPair>	keyValuesView()	Returns a view of the key/value pairs in this map.
String	makeString()	Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
String	makeString(String separator)	Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
String	makeString(String start, String separator, String end)	Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.
short	max()
short	maxIfEmpty(short defaultValue)
double	median()
short	min()
short	minIfEmpty(short defaultValue)
boolean	noneSatisfy(ShortPredicate predicate)	Returns true if none of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
boolean	notEmpty()	The English equivalent of !this.isEmpty()
void	put(float key, short value)	Associates a value with the specified key.
void	putAll(FloatShortMap map)	Puts all of the key/value mappings from the specified map into this map.
void	putPair(FloatShortPair keyValuePair)	This method allows MutableFloatShortMap the ability to add an element in the form of FloatShortPair.
MutableFloatShortMap	reject(FloatShortPredicate predicate)	Return a copy of this map containing only the key/value pairs that do not match the predicate.
MutableShortBag	reject(ShortPredicate predicate)	Returns a new ShortIterable with all of the elements in the ShortIterable that return false for the specified predicate.
void	remove(float key)	Removes the mapping associated with the key, if one exists, from the map.
void	removeKey(float key)	Removes the mapping associated with the key, if one exists, from the map.
short	removeKeyIfAbsent(float key, short value)	Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
MutableFloatShortMap	select(FloatShortPredicate predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
MutableShortBag	select(ShortPredicate predicate)	Returns a new ShortIterable with all of the elements in the ShortIterable that return true for the specified predicate.
MutableShortIterator	shortIterator()	Returns a primitive iterator that can be used to iterate over the ShortIterable in an imperative style.
int	size()	Returns the number of items in this iterable.
long	sum()
short[]	toArray()	Converts the ShortIterable to a primitive short array.
short[]	toArray(short[] target)	Converts the ShortIterable to a primitive short array.
MutableShortBag	toBag()	Converts the ShortIterable to a new MutableShortBag.
ImmutableFloatShortMap	toImmutable()	Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.
MutableShortList	toList()	Converts the ShortIterable to a new MutableShortList.
MutableShortSet	toSet()	Converts the ShortIterable to a new MutableShortSet.
short[]	toSortedArray()
MutableShortList	toSortedList()
String	toString()	Follows the same general contract as AbstractMap.toString()
short	updateValue(float key, short initialValueIfAbsent, ShortToShortFunction 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(FloatShortToShortFunction function)	Updates the values in-place.
MutableShortCollection	values()	Returns the values in this map as a separate collection.
MutableFloatShortMap	withKeyValue(float key, short value)	Associates a value with the specified key.
MutableFloatShortMap	withoutAllKeys(FloatIterable keys)	Removes the mappings associated with all the keys, if they exist, from this map.
MutableFloatShortMap	withoutKey(float key)	Removes the mapping associated with the key, if one exists, from this map.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

injectIntoKeyValue

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

withAllKeyValues

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

averageIfEmpty, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAny, containsAny, containsNone, containsNone, flatCollect, forEach, injectIntoBoolean, injectIntoByte, injectIntoChar, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, injectIntoShort, medianIfEmpty, reduce, reduceIfEmpty, reject, select, summaryStatistics, toSortedList, toSortedListBy, toSortedListBy

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

tap

Constructor Details

UnmodifiableFloatShortMap

public UnmodifiableFloatShortMap(MutableFloatShortMap map)

Method Details

clear

public void clear()

Description copied from interface: MutableShortValuesMap

Removes all entries from this map.

Specified by:

clear in interface MutableShortValuesMap

put

public void put(float key,
 short value)

Description copied from interface: MutableFloatShortMap

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 MutableFloatShortMap

Parameters:

key - the key

value - the value to associate with value

putPair

public void putPair(FloatShortPair keyValuePair)

Description copied from interface: MutableFloatShortMap

This method allows MutableFloatShortMap the ability to add an element in the form of FloatShortPair.

Specified by:

putPair in interface MutableFloatShortMap

See Also:

• MutableFloatShortMap.put(float, short)

putAll

public void putAll(FloatShortMap map)

Description copied from interface: MutableFloatShortMap

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 MutableFloatShortMap

Parameters:

map - the map to copy into this map

updateValues

public void updateValues(FloatShortToShortFunction function)

Description copied from interface: MutableFloatShortMap

Updates the values in-place.

Specified by:

updateValues in interface MutableFloatShortMap

Parameters:

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

removeKey

public void removeKey(float key)

Description copied from interface: MutableFloatShortMap

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

Specified by:

removeKey in interface MutableFloatShortMap

Parameters:

key - the key to remove

See Also:

• MutableFloatShortMap.remove(float)

remove

public void remove(float key)

Description copied from interface: MutableFloatShortMap

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

Specified by:

remove in interface MutableFloatShortMap

Parameters:

key - the key to remove

See Also:

• MutableFloatShortMap.removeKey(float)

removeKeyIfAbsent

public short removeKeyIfAbsent(float key,
 short value)

Description copied from interface: MutableFloatShortMap

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 MutableFloatShortMap

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 short getIfAbsentPut(float key,
 short value)

Description copied from interface: MutableFloatShortMap

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 MutableFloatShortMap

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 short getAndPut(float key,
 short putValue,
 short defaultValue)

Description copied from interface: MutableFloatShortMap

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

Specified by:

getAndPut in interface MutableFloatShortMap

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 short getIfAbsentPut(float key,
 ShortFunction0 function)

Description copied from interface: MutableFloatShortMap

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 MutableFloatShortMap

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

getIfAbsentPutWithKey

public short getIfAbsentPutWithKey(float key,
 FloatToShortFunction function)

Description copied from interface: MutableFloatShortMap

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 MutableFloatShortMap

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

getIfAbsentPutWith

public <P> short getIfAbsentPutWith(float key,
 ShortFunction<? super P> function,
 P parameter)

Description copied from interface: MutableFloatShortMap

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 MutableFloatShortMap

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

updateValue

public short updateValue(float key,
 short initialValueIfAbsent,
 ShortToShortFunction function)

Description copied from interface: MutableFloatShortMap

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 MutableFloatShortMap

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

get

public short get(float key)

Description copied from interface: FloatShortMap

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 FloatShortMap

Parameters:

key - the key

Returns:

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

getIfAbsent

public short getIfAbsent(float key,
 short ifAbsent)

Description copied from interface: FloatShortMap

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

Specified by:

getIfAbsent in interface FloatShortMap

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 short getOrThrow(float key)

Description copied from interface: FloatShortMap

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

Specified by:

getOrThrow in interface FloatShortMap

Parameters:

key - the key

Returns:

the value associated with the key

containsKey

public boolean containsKey(float key)

Description copied from interface: FloatShortMap

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

Specified by:

containsKey in interface FloatShortMap

Parameters:

key - the key

Returns:

if a mapping exists in this map for the key

containsValue

public boolean containsValue(short value)

Description copied from interface: ShortValuesMap

Returns whether or not this map contains the value.

Specified by:

containsValue in interface ShortValuesMap

Parameters:

value - the value to test

Returns:

if this collection contains the value

forEachValue

public void forEachValue(ShortProcedure procedure)

Description copied from interface: ShortValuesMap

Iterates through each value in this map.

Specified by:

forEachValue in interface ShortValuesMap

Parameters:

procedure - the procedure to invoke for each value in this map.

forEachKey

public void forEachKey(FloatProcedure procedure)

Description copied from interface: FloatShortMap

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

Specified by:

forEachKey in interface FloatShortMap

Parameters:

procedure - the procedure to invoke for each key

forEachKeyValue

public void forEachKeyValue(FloatShortProcedure procedure)

Description copied from interface: FloatShortMap

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

Specified by:

forEachKeyValue in interface FloatShortMap

Parameters:

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

keysView

public LazyFloatIterable keysView()

Description copied from interface: FloatShortMap

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 FloatShortMap

Returns:

a view of the keys in this map

keyValuesView

public RichIterable<FloatShortPair> keyValuesView()

Description copied from interface: FloatShortMap

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 FloatShortMap

Returns:

a view of the keys in this map

flipUniqueValues

public MutableShortFloatMap flipUniqueValues()

Description copied from interface: FloatShortMap

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

Specified by:

flipUniqueValues in interface FloatShortMap

Specified by:

flipUniqueValues in interface MutableFloatShortMap

select

public MutableFloatShortMap select(FloatShortPredicate predicate)

Description copied from interface: FloatShortMap

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

Specified by:

select in interface FloatShortMap

Specified by:

select in interface MutableFloatShortMap

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 MutableFloatShortMap reject(FloatShortPredicate predicate)

Description copied from interface: FloatShortMap

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

Specified by:

reject in interface FloatShortMap

Specified by:

reject in interface MutableFloatShortMap

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

shortIterator

public MutableShortIterator shortIterator()

Description copied from interface: ShortIterable

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

Specified by:

shortIterator in interface MutableShortValuesMap

Specified by:

shortIterator in interface ShortIterable

each

public void each(ShortProcedure procedure)

Description copied from interface: ShortIterable

A synonym for forEach.

Specified by:

each in interface ShortIterable

Since:

7.0.

count

public int count(ShortPredicate predicate)

Description copied from interface: ShortIterable

Returns a count of the number of elements in the ShortIterable that return true for the specified predicate.

Specified by:

count in interface ShortIterable

anySatisfy

public boolean anySatisfy(ShortPredicate predicate)

Description copied from interface: ShortIterable

Returns true if any of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.

Specified by:

anySatisfy in interface ShortIterable

allSatisfy

public boolean allSatisfy(ShortPredicate predicate)

Description copied from interface: ShortIterable

Returns true if all of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.

Specified by:

allSatisfy in interface ShortIterable

noneSatisfy

public boolean noneSatisfy(ShortPredicate predicate)

Description copied from interface: ShortIterable

Returns true if none of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.

Specified by:

noneSatisfy in interface ShortIterable

select

public MutableShortBag select(ShortPredicate predicate)

Description copied from interface: ShortIterable

Returns a new ShortIterable with all of the elements in the ShortIterable that return true for the specified predicate.

Specified by:

select in interface MutableShortValuesMap

Specified by:

select in interface ShortIterable

Specified by:

select in interface ShortValuesMap

reject

public MutableShortBag reject(ShortPredicate predicate)

Description copied from interface: ShortIterable

Returns a new ShortIterable with all of the elements in the ShortIterable that return false for the specified predicate.

Specified by:

reject in interface MutableShortValuesMap

Specified by:

reject in interface ShortIterable

Specified by:

reject in interface ShortValuesMap

collect

public <V> MutableBag<V> collect(ShortToObjectFunction<? extends V> function)

Description copied from interface: ShortIterable

Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Specified by:

collect in interface MutableShortValuesMap

Specified by:

collect in interface ShortIterable

Specified by:

collect in interface ShortValuesMap

detectIfNone

public short detectIfNone(ShortPredicate predicate,
 short ifNone)

Specified by:

detectIfNone in interface ShortIterable

sum

public long sum()

Specified by:

sum in interface ShortIterable

max

public short max()

Specified by:

max in interface ShortIterable

maxIfEmpty

public short maxIfEmpty(short defaultValue)

Specified by:

maxIfEmpty in interface ShortIterable

min

public short min()

Specified by:

min in interface ShortIterable

minIfEmpty

public short minIfEmpty(short defaultValue)

Specified by:

minIfEmpty in interface ShortIterable

average

public double average()

Specified by:

average in interface ShortIterable

median

public double median()

Specified by:

median in interface ShortIterable

addToValue

public short addToValue(float key,
 short toBeAdded)

Description copied from interface: MutableFloatShortMap

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 MutableFloatShortMap

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

toSortedArray

public short[] toSortedArray()

Specified by:

toSortedArray in interface ShortIterable

toSortedList

public MutableShortList toSortedList()

Specified by:

toSortedList in interface ShortIterable

toArray

public short[] toArray()

Description copied from interface: ShortIterable

Converts the ShortIterable to a primitive short array.

Specified by:

toArray in interface ShortIterable

toArray

public short[] toArray(short[] target)

Description copied from interface: ShortIterable

Converts the ShortIterable to a primitive short array. If the collection fits into the provided array it is used to store its elements and is returned from the method, otherwise a new array of the appropriate size is allocated and returned. If the iterable is empty, the target array is returned unchanged.

Specified by:

toArray in interface ShortIterable

contains

public boolean contains(short value)

Description copied from interface: ShortIterable

Returns true if the value is contained in the ShortIterable, and false if it is not.

Specified by:

contains in interface ShortIterable

containsAll

public boolean containsAll(short... source)

Description copied from interface: ShortIterable

Returns true if all of the values specified in the source array are contained in the ShortIterable, and false if they are not.

Specified by:

containsAll in interface ShortIterable

containsAll

public boolean containsAll(ShortIterable source)

Description copied from interface: ShortIterable

Returns true if all of the values specified in the source ShortIterable are contained in the ShortIterable, and false if they are not.

Specified by:

containsAll in interface ShortIterable

toList

public MutableShortList toList()

Description copied from interface: ShortIterable

Converts the ShortIterable to a new MutableShortList.

Specified by:

toList in interface ShortIterable

toSet

public MutableShortSet toSet()

Description copied from interface: ShortIterable

Converts the ShortIterable to a new MutableShortSet.

Specified by:

toSet in interface ShortIterable

toBag

public MutableShortBag toBag()

Description copied from interface: ShortIterable

Converts the ShortIterable to a new MutableShortBag.

Specified by:

toBag in interface ShortIterable

asLazy

public LazyShortIterable asLazy()

Description copied from interface: ShortIterable

Returns a LazyShortIterable adapter wrapping the source ShortIterable.

Specified by:

asLazy in interface ShortIterable

withKeyValue

public MutableFloatShortMap withKeyValue(float key,
 short value)

Description copied from interface: MutableFloatShortMap

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 MutableFloatShortMap

Parameters:

key - the key

value - the value to associate with value

Returns:

this map

See Also:

• MutableFloatShortMap.put(float, short)

withoutKey

public MutableFloatShortMap withoutKey(float key)

Description copied from interface: MutableFloatShortMap

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

Specified by:

withoutKey in interface MutableFloatShortMap

Parameters:

key - the key to remove

Returns:

this map

See Also:

• MutableFloatShortMap.remove(float)

withoutAllKeys

public MutableFloatShortMap withoutAllKeys(FloatIterable keys)

Description copied from interface: MutableFloatShortMap

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

Specified by:

withoutAllKeys in interface MutableFloatShortMap

Parameters:

keys - the keys to remove

Returns:

this map

See Also:

• MutableFloatShortMap.remove(float)

asUnmodifiable

public MutableFloatShortMap asUnmodifiable()

Description copied from interface: MutableFloatShortMap

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 FloatShortMap.toImmutable() while still providing immutability.

Specified by:

asUnmodifiable in interface MutableFloatShortMap

Returns:

an unmodifiable view of this map

asSynchronized

public MutableFloatShortMap asSynchronized()

Description copied from interface: MutableFloatShortMap

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 MutableFloatShortMap

Returns:

a synchronized view of this map

toImmutable

public ImmutableFloatShortMap toImmutable()

Description copied from interface: FloatShortMap

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 FloatShortMap

Returns:

an immutable map that is equivalent to this one

size

public int size()

Description copied from interface: PrimitiveIterable

Returns the number of items in this iterable.

Specified by:

size in interface PrimitiveIterable

isEmpty

public boolean isEmpty()

Description copied from interface: PrimitiveIterable

Returns true if this iterable has zero items.

Specified by:

isEmpty in interface PrimitiveIterable

notEmpty

public boolean notEmpty()

Description copied from interface: PrimitiveIterable

The English equivalent of !this.isEmpty()

Specified by:

notEmpty in interface PrimitiveIterable

keySet

public MutableFloatSet keySet()

Description copied from interface: FloatShortMap

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 FloatShortMap

Returns:

a mutable set containing the keys in this map

values

public MutableShortCollection values()

Description copied from interface: ShortValuesMap

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 ShortValuesMap

Returns:

the values as a collection backed by this map

equals

public boolean equals(Object otherMap)

Description copied from interface: FloatShortMap

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

Specified by:

equals in interface FloatShortMap

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: FloatShortMap

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

Specified by:

hashCode in interface FloatShortMap

Overrides:

hashCode in class Object

toString

public String toString()

Description copied from interface: FloatShortMap

Follows the same general contract as AbstractMap.toString()

Specified by:

toString in interface FloatShortMap

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class Object

Returns:

a string representation of this FloatShortMap

See Also:

• AbstractCollection.toString()

makeString

public String makeString()

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

makeString

public String makeString(String separator)

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

makeString

public String makeString(String start,
 String separator,
 String end)

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

appendString

public void appendString(Appendable appendable)

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString().

Specified by:

appendString in interface PrimitiveIterable

appendString

public void appendString(Appendable appendable,
 String separator)

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String).

Specified by:

appendString in interface PrimitiveIterable

appendString

public void appendString(Appendable appendable,
 String start,
 String separator,
 String end)

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String, String, String).

Specified by:

appendString in interface PrimitiveIterable

injectInto

public <T> T injectInto(T injectedValue,
 ObjectShortToObjectFunction<? super T,? extends T> function)

Specified by:

injectInto in interface ShortIterable

chunk

public RichIterable<ShortIterable> chunk(int size)

Description copied from interface: ShortIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface ShortIterable

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing ShortIterables of size size, except the last will be truncated if the elements don't divide evenly.