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

Class UnmodifiableObjectShortMap<K>

java.lang.Object

org.eclipse.collections.impl.map.mutable.primitive.UnmodifiableObjectShortMap<K>

All Implemented Interfaces:

Serializable, MutableObjectShortMap<K>, ObjectShortMap<K>, PrimitiveIterable, ShortIterable

public class UnmodifiableObjectShortMap<K>
extends Object
implements MutableObjectShortMap<K>, Serializable

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

Since:

3.2

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
UnmodifiableObjectShortMap(MutableObjectShortMap<K> map)

Method Summary

Modifier and Type	Method	Description
short	addToValue(K key, short toBeAdded)
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.
MutableObjectShortMap<K>	asSynchronized()
MutableObjectShortMap<K>	asUnmodifiable()
double	average()
RichIterable<ShortIterable>	chunk(int size)	Partitions elements in fixed size chunks.
void	clear()	Removes all entries from this map.
<V1> MutableCollection<V1>	collect(ShortToObjectFunction<? extends V1> 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(Object 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 obj)
MutableShortObjectMap<K>	flipUniqueValues()	Return the ShortObjectMap that is obtained by flipping the direction of this map and making the associations from value to key.
void	forEach(ShortProcedure procedure)	Applies the ShortProcedure to each element in the ShortIterable.
void	forEachKey(Procedure<? super K> procedure)	Iterates through each key in the map, invoking the procedure for each.
void	forEachKeyValue(ObjectShortProcedure<? super K> 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(Object key)	Retrieves the value associated with the key.
short	getIfAbsent(Object key, short ifAbsent)	Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
short	getIfAbsentPut(K 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(K 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(K 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(K key, ShortFunction<? super K> 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(Object key)	Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.
int	hashCode()
<T> T	injectInto(T injectedValue, ObjectShortToObjectFunction<? super T,? extends T> function)
boolean	isEmpty()	Returns true if this iterable has zero items.
Set<K>	keySet()	Returns a set containing all the keys in this map.
LazyIterable<K>	keysView()	Returns a view of the keys in this map.
RichIterable<ObjectShortPair<K>>	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(K key, short value)	Associates a value with the specified key.
void	putAll(ObjectShortMap<? extends K> map)	Puts all of the key/value mappings from the specified map into this map.
void	putPair(ObjectShortPair<K> keyValuePair)	This method allows MutableObjectShortMap the ability to add an element in the form of ObjectShortPair<K>.
MutableObjectShortMap<K>	reject(ObjectShortPredicate<? super K> predicate)	Return a copy of this map containing only the key/value pairs that do not match the predicate.
MutableShortCollection	reject(ShortPredicate predicate)	Returns a new ShortIterable with all of the elements in the ShortIterable that return false for the specified predicate.
void	remove(Object key)	Removes the mapping associated with the key, if one exists, from the map.
void	removeKey(K key)	Removes the mapping associated with the key, if one exists, from the map.
short	removeKeyIfAbsent(K key, short value)	Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
MutableObjectShortMap<K>	select(ObjectShortPredicate<? super K> predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
MutableShortCollection	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.
ImmutableObjectShortMap<K>	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(K 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(ObjectShortToShortFunction<? super K> function)	Updates the values in-place.
MutableShortCollection	values()	Returns the values in this map as a separate collection.
MutableObjectShortMap<K>	withKeyValue(K key, short value)	Associates a value with the specified key.
MutableObjectShortMap<K>	withoutAllKeys(Iterable<? extends K> keys)	Removes the mappings associated with all the keys, if they exist, from this map.
MutableObjectShortMap<K>	withoutKey(K 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.MutableObjectShortMap

tap, 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, medianIfEmpty, reduce, reduceIfEmpty, reject, select, summaryStatistics, toSortedList, toSortedListBy, toSortedListBy

Constructor Details

UnmodifiableObjectShortMap

public UnmodifiableObjectShortMap(MutableObjectShortMap<K> map)

Method Details

clear

public void clear()

Description copied from interface: MutableObjectShortMap

Removes all entries from this map.

Specified by:

clear in interface MutableObjectShortMap<K>

put

public void put(K key,
 short value)

Description copied from interface: MutableObjectShortMap

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 MutableObjectShortMap<K>

Parameters:

key - the key

value - the value to associate with value

putPair

public void putPair(ObjectShortPair<K> keyValuePair)

Description copied from interface: MutableObjectShortMap

This method allows MutableObjectShortMap the ability to add an element in the form of ObjectShortPair<K>.

Specified by:

putPair in interface MutableObjectShortMap<K>

See Also:

• MutableObjectShortMap.put(Object, short)

putAll

public void putAll(ObjectShortMap<? extends K> map)

Description copied from interface: MutableObjectShortMap

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 MutableObjectShortMap<K>

Parameters:

map - the map to copy into this map

updateValues

public void updateValues(ObjectShortToShortFunction<? super K> function)

Description copied from interface: MutableObjectShortMap

Updates the values in-place.

Specified by:

updateValues in interface MutableObjectShortMap<K>

Parameters:

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

removeKey

public void removeKey(K key)

Description copied from interface: MutableObjectShortMap

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

Specified by:

removeKey in interface MutableObjectShortMap<K>

Parameters:

key - the key to remove

See Also:

• MutableObjectShortMap.remove(Object)

remove

public void remove(Object key)

Description copied from interface: MutableObjectShortMap

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

Specified by:

remove in interface MutableObjectShortMap<K>

Parameters:

key - the key to remove

See Also:

• MutableObjectShortMap.removeKey(K)

removeKeyIfAbsent

public short removeKeyIfAbsent(K key,
 short value)

Description copied from interface: MutableObjectShortMap

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 MutableObjectShortMap<K>

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

Description copied from interface: MutableObjectShortMap

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

Specified by:

getIfAbsentPut in interface MutableObjectShortMap<K>

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

getIfAbsentPut

public short getIfAbsentPut(K key,
 ShortFunction0 function)

Description copied from interface: MutableObjectShortMap

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 MutableObjectShortMap<K>

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(K key,
 ShortFunction<? super K> function)

Description copied from interface: MutableObjectShortMap

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 MutableObjectShortMap<K>

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(K key,
 ShortFunction<? super P> function,
 P parameter)

Description copied from interface: MutableObjectShortMap

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 MutableObjectShortMap<K>

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(K key,
 short initialValueIfAbsent,
 ShortToShortFunction function)

Description copied from interface: MutableObjectShortMap

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 MutableObjectShortMap<K>

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

addToValue

public short addToValue(K key,
 short toBeAdded)

Specified by:

addToValue in interface MutableObjectShortMap<K>

get

public short get(Object key)

Description copied from interface: ObjectShortMap

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 ObjectShortMap<K>

Parameters:

key - the key

Returns:

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

getOrThrow

public short getOrThrow(Object key)

Description copied from interface: ObjectShortMap

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

Specified by:

getOrThrow in interface ObjectShortMap<K>

Parameters:

key - the key

Returns:

the value associated with the key

getIfAbsent

public short getIfAbsent(Object key,
 short ifAbsent)

Description copied from interface: ObjectShortMap

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

Specified by:

getIfAbsent in interface ObjectShortMap<K>

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.

containsKey

public boolean containsKey(Object key)

Description copied from interface: ObjectShortMap

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

Specified by:

containsKey in interface ObjectShortMap<K>

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: ObjectShortMap

Returns whether or not this map contains the value.

Specified by:

containsValue in interface ObjectShortMap<K>

Parameters:

value - the value to test

Returns:

if this collection contains the value

forEachValue

public void forEachValue(ShortProcedure procedure)

Description copied from interface: ObjectShortMap

Iterates through each value in this map.

Specified by:

forEachValue in interface ObjectShortMap<K>

Parameters:

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

forEachKey

public void forEachKey(Procedure<? super K> procedure)

Description copied from interface: ObjectShortMap

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

Specified by:

forEachKey in interface ObjectShortMap<K>

Parameters:

procedure - the procedure to invoke for each key

forEachKeyValue

public void forEachKeyValue(ObjectShortProcedure<? super K> procedure)

Description copied from interface: ObjectShortMap

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

Specified by:

forEachKeyValue in interface ObjectShortMap<K>

Parameters:

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

select

public MutableObjectShortMap<K> select(ObjectShortPredicate<? super K> predicate)

Description copied from interface: ObjectShortMap

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

Specified by:

select in interface MutableObjectShortMap<K>

Specified by:

select in interface ObjectShortMap<K>

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 MutableObjectShortMap<K> reject(ObjectShortPredicate<? super K> predicate)

Description copied from interface: ObjectShortMap

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

Specified by:

reject in interface MutableObjectShortMap<K>

Specified by:

reject in interface ObjectShortMap<K>

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 MutableObjectShortMap<K>

Specified by:

shortIterator in interface ShortIterable

forEach

public void forEach(ShortProcedure procedure)

Description copied from interface: ShortIterable

Applies the ShortProcedure to each element in the ShortIterable.

Specified by:

forEach 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 MutableShortCollection 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 MutableObjectShortMap<K>

Specified by:

select in interface ShortIterable

reject

public MutableShortCollection 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 MutableObjectShortMap<K>

Specified by:

reject in interface ShortIterable

detectIfNone

public short detectIfNone(ShortPredicate predicate,
 short ifNone)

Specified by:

detectIfNone in interface ShortIterable

collect

public <V1> MutableCollection<V1> collect(ShortToObjectFunction<? extends V1> 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 MutableObjectShortMap<K>

Specified by:

collect 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

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 MutableObjectShortMap<K> withKeyValue(K key,
 short value)

Description copied from interface: MutableObjectShortMap

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 MutableObjectShortMap<K>

Parameters:

key - the key

value - the value to associate with value

Returns:

this map

See Also:

• MutableObjectShortMap.put(K, short)

withoutKey

public MutableObjectShortMap<K> withoutKey(K key)

Description copied from interface: MutableObjectShortMap

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

Specified by:

withoutKey in interface MutableObjectShortMap<K>

Parameters:

key - the key to remove

Returns:

this map

See Also:

• MutableObjectShortMap.remove(Object)

withoutAllKeys

public MutableObjectShortMap<K> withoutAllKeys(Iterable<? extends K> keys)

Description copied from interface: MutableObjectShortMap

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

Specified by:

withoutAllKeys in interface MutableObjectShortMap<K>

Parameters:

keys - the keys to remove

Returns:

this map

See Also:

• MutableObjectShortMap.remove(Object)

asUnmodifiable

public MutableObjectShortMap<K> asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableObjectShortMap<K>

asSynchronized

public MutableObjectShortMap<K> asSynchronized()

Specified by:

asSynchronized in interface MutableObjectShortMap<K>

toImmutable

public ImmutableObjectShortMap<K> toImmutable()

Description copied from interface: ObjectShortMap

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 ObjectShortMap<K>

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 Set<K> keySet()

Description copied from interface: ObjectShortMap

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 ObjectShortMap<K>

Returns:

a mutable set containing the keys in this map

values

public MutableShortCollection values()

Description copied from interface: ObjectShortMap

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 ObjectShortMap<K>

Returns:

the values as a collection backed by this map

keysView

public LazyIterable<K> keysView()

Description copied from interface: ObjectShortMap

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 ObjectShortMap<K>

Returns:

a view of the keys in this map

keyValuesView

public RichIterable<ObjectShortPair<K>> keyValuesView()

Description copied from interface: ObjectShortMap

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 ObjectShortMap<K>

Returns:

a view of the keys in this map

flipUniqueValues

public MutableShortObjectMap<K> flipUniqueValues()

Description copied from interface: ObjectShortMap

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

Specified by:

flipUniqueValues in interface MutableObjectShortMap<K>

Specified by:

flipUniqueValues in interface ObjectShortMap<K>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Description copied from interface: ObjectShortMap

Follows the same general contract as AbstractMap.toString()

Specified by:

toString in interface ObjectShortMap<K>

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class Object

Returns:

a string representation of this ObjectShortMap

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.