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

Class UnmodifiableObjectIntMap<K>

java.lang.Object

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

All Implemented Interfaces:

Serializable, IntIterable, MutableObjectIntMap<K>, ObjectIntMap<K>, PrimitiveIterable

public class UnmodifiableObjectIntMap<K>
extends Object
implements MutableObjectIntMap<K>, Serializable

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

Since:

3.2

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
UnmodifiableObjectIntMap(MutableObjectIntMap<K> map)

Method Summary

Modifier and Type	Method	Description
int	addToValue(K key, int toBeAdded)
boolean	allSatisfy(IntPredicate predicate)	Returns true if all of the elements in the IntIterable return true for the specified predicate, otherwise returns false.
boolean	anySatisfy(IntPredicate predicate)	Returns true if any of the elements in the IntIterable 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.
LazyIntIterable	asLazy()	Returns a LazyIntIterable adapter wrapping the source IntIterable.
MutableObjectIntMap<K>	asSynchronized()
MutableObjectIntMap<K>	asUnmodifiable()
double	average()
RichIterable<IntIterable>	chunk(int size)	Partitions elements in fixed size chunks.
void	clear()	Removes all entries from this map.
<V1> MutableCollection<V1>	collect(IntToObjectFunction<? extends V1> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
boolean	contains(int value)	Returns true if the value is contained in the IntIterable, and false if it is not.
boolean	containsAll(int... source)	Returns true if all of the values specified in the source array are contained in the IntIterable, and false if they are not.
boolean	containsAll(IntIterable source)	Returns true if all of the values specified in the source IntIterable are contained in the IntIterable, and false if they are not.
boolean	containsKey(Object key)	Returns whether or not the key is present in the map.
boolean	containsValue(int value)	Returns whether or not this map contains the value.
int	count(IntPredicate predicate)	Returns a count of the number of elements in the IntIterable that return true for the specified predicate.
int	detectIfNone(IntPredicate predicate, int ifNone)
void	each(IntProcedure procedure)	A synonym for forEach.
boolean	equals(Object obj)
MutableIntObjectMap<K>	flipUniqueValues()	Return the IntObjectMap that is obtained by flipping the direction of this map and making the associations from value to key.
void	forEachKey(Procedure<? super K> procedure)	Iterates through each key in the map, invoking the procedure for each.
void	forEachKeyValue(ObjectIntProcedure<? super K> procedure)	Iterates through each key/value pair in the map, invoking the procedure for each.
void	forEachValue(IntProcedure procedure)	Iterates through each value in this map.
int	get(Object key)	Retrieves the value associated with the key.
int	getAndPut(K key, int defaultValue, int putValue)	Retrieves the value associated with the key if one exists; if it does not, associates a putValue with the key.
int	getIfAbsent(Object key, int ifAbsent)	Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
int	getIfAbsentPut(K 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(K 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(K 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(K key, IntFunction<? 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.
int	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, ObjectIntToObjectFunction<? super T,? extends T> function)
MutableIntIterator	intIterator()	Returns a primitive iterator that can be used to iterate over the IntIterable in an imperative style.
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<ObjectIntPair<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.
int	max()
int	maxIfEmpty(int defaultValue)
double	median()
int	min()
int	minIfEmpty(int defaultValue)
boolean	noneSatisfy(IntPredicate predicate)	Returns true if none of the elements in the IntIterable return true for the specified predicate, otherwise returns false.
boolean	notEmpty()	The English equivalent of !this.isEmpty()
void	put(K key, int value)	Associates a value with the specified key.
void	putAll(ObjectIntMap<? extends K> map)	Puts all of the key/value mappings from the specified map into this map.
void	putPair(ObjectIntPair<K> keyValuePair)	This method allows MutableObjectIntMap the ability to add an element in the form of ObjectIntPair<K>.
MutableIntCollection	reject(IntPredicate predicate)	Returns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.
MutableObjectIntMap<K>	reject(ObjectIntPredicate<? super K> predicate)	Return a copy of this map containing only the key/value pairs that do not match the 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.
int	removeKeyIfAbsent(K key, int value)	Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
MutableIntCollection	select(IntPredicate predicate)	Returns a new IntIterable with all of the elements in the IntIterable that return true for the specified predicate.
MutableObjectIntMap<K>	select(ObjectIntPredicate<? super K> predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
int	size()	Returns the number of items in this iterable.
long	sum()
int[]	toArray()	Converts the IntIterable to a primitive int array.
int[]	toArray(int[] target)	Converts the IntIterable to a primitive int array.
MutableIntBag	toBag()	Converts the IntIterable to a new MutableIntBag.
ImmutableObjectIntMap<K>	toImmutable()	Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.
MutableIntList	toList()	Converts the IntIterable to a new MutableIntList.
MutableIntSet	toSet()	Converts the IntIterable to a new MutableIntSet.
int[]	toSortedArray()
MutableIntList	toSortedList()
String	toString()	Follows the same general contract as AbstractMap.toString()
int	updateValue(K 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(ObjectIntToIntFunction<? super K> function)	Updates the values in-place.
MutableIntCollection	values()	Returns the values in this map as a separate collection.
MutableObjectIntMap<K>	withKeyValue(K key, int value)	Associates a value with the specified key.
MutableObjectIntMap<K>	withoutAllKeys(Iterable<? extends K> keys)	Removes the mappings associated with all the keys, if they exist, from this map.
MutableObjectIntMap<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.IntIterable

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.MutableObjectIntMap

tap, withAllKeyValues

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

injectIntoKeyValue

Constructor Details

UnmodifiableObjectIntMap

public UnmodifiableObjectIntMap(MutableObjectIntMap<K> map)

Method Details

getAndPut

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

Description copied from interface: MutableObjectIntMap

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

Specified by:

getAndPut in interface MutableObjectIntMap<K>

Parameters:

key - the key

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

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

Returns:

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

clear

public void clear()

Description copied from interface: MutableObjectIntMap

Removes all entries from this map.

Specified by:

clear in interface MutableObjectIntMap<K>

put

public void put(K key,
 int value)

Description copied from interface: MutableObjectIntMap

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

Parameters:

key - the key

value - the value to associate with value

putPair

public void putPair(ObjectIntPair<K> keyValuePair)

Description copied from interface: MutableObjectIntMap

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

Specified by:

putPair in interface MutableObjectIntMap<K>

See Also:

• MutableObjectIntMap.put(Object, int)

putAll

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

Description copied from interface: MutableObjectIntMap

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

Parameters:

map - the map to copy into this map

updateValues

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

Description copied from interface: MutableObjectIntMap

Updates the values in-place.

Specified by:

updateValues in interface MutableObjectIntMap<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: MutableObjectIntMap

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

Specified by:

removeKey in interface MutableObjectIntMap<K>

Parameters:

key - the key to remove

See Also:

• MutableObjectIntMap.remove(Object)

remove

public void remove(Object key)

Description copied from interface: MutableObjectIntMap

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

Specified by:

remove in interface MutableObjectIntMap<K>

Parameters:

key - the key to remove

See Also:

• MutableObjectIntMap.removeKey(K)

removeKeyIfAbsent

public int removeKeyIfAbsent(K key,
 int value)

Description copied from interface: MutableObjectIntMap

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 MutableObjectIntMap<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 int getIfAbsentPut(K key,
 int value)

Description copied from interface: MutableObjectIntMap

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 MutableObjectIntMap<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 int getIfAbsentPut(K key,
 IntFunction0 function)

Description copied from interface: MutableObjectIntMap

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 MutableObjectIntMap<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 int getIfAbsentPutWithKey(K key,
 IntFunction<? super K> function)

Description copied from interface: MutableObjectIntMap

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 MutableObjectIntMap<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> int getIfAbsentPutWith(K key,
 IntFunction<? super P> function,
 P parameter)

Description copied from interface: MutableObjectIntMap

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 MutableObjectIntMap<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 int updateValue(K key,
 int initialValueIfAbsent,
 IntToIntFunction function)

Description copied from interface: MutableObjectIntMap

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 MutableObjectIntMap<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 int addToValue(K key,
 int toBeAdded)

Specified by:

addToValue in interface MutableObjectIntMap<K>

get

public int get(Object key)

Description copied from interface: ObjectIntMap

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

Parameters:

key - the key

Returns:

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

getOrThrow

public int getOrThrow(Object key)

Description copied from interface: ObjectIntMap

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

Specified by:

getOrThrow in interface ObjectIntMap<K>

Parameters:

key - the key

Returns:

the value associated with the key

getIfAbsent

public int getIfAbsent(Object key,
 int ifAbsent)

Description copied from interface: ObjectIntMap

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

Specified by:

getIfAbsent in interface ObjectIntMap<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: ObjectIntMap

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

Specified by:

containsKey in interface ObjectIntMap<K>

Parameters:

key - the key

Returns:

if a mapping exists in this map for the key

containsValue

public boolean containsValue(int value)

Description copied from interface: ObjectIntMap

Returns whether or not this map contains the value.

Specified by:

containsValue in interface ObjectIntMap<K>

Parameters:

value - the value to test

Returns:

if this collection contains the value

forEachValue

public void forEachValue(IntProcedure procedure)

Description copied from interface: ObjectIntMap

Iterates through each value in this map.

Specified by:

forEachValue in interface ObjectIntMap<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: ObjectIntMap

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

Specified by:

forEachKey in interface ObjectIntMap<K>

Parameters:

procedure - the procedure to invoke for each key

forEachKeyValue

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

Description copied from interface: ObjectIntMap

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

Specified by:

forEachKeyValue in interface ObjectIntMap<K>

Parameters:

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

select

public MutableObjectIntMap<K> select(ObjectIntPredicate<? super K> predicate)

Description copied from interface: ObjectIntMap

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

Specified by:

select in interface MutableObjectIntMap<K>

Specified by:

select in interface ObjectIntMap<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 MutableObjectIntMap<K> reject(ObjectIntPredicate<? super K> predicate)

Description copied from interface: ObjectIntMap

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

Specified by:

reject in interface MutableObjectIntMap<K>

Specified by:

reject in interface ObjectIntMap<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

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

each

public void each(IntProcedure procedure)

Description copied from interface: IntIterable

A synonym for forEach.

Specified by:

each in interface IntIterable

Since:

7.0.

count

public int count(IntPredicate predicate)

Description copied from interface: IntIterable

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

Specified by:

count in interface IntIterable

anySatisfy

public boolean anySatisfy(IntPredicate predicate)

Description copied from interface: IntIterable

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

Specified by:

anySatisfy in interface IntIterable

allSatisfy

public boolean allSatisfy(IntPredicate predicate)

Description copied from interface: IntIterable

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

Specified by:

allSatisfy in interface IntIterable

noneSatisfy

public boolean noneSatisfy(IntPredicate predicate)

Description copied from interface: IntIterable

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

Specified by:

noneSatisfy in interface IntIterable

select

public MutableIntCollection select(IntPredicate predicate)

Description copied from interface: IntIterable

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

Specified by:

select in interface IntIterable

Specified by:

select in interface MutableObjectIntMap<K>

reject

public MutableIntCollection reject(IntPredicate predicate)

Description copied from interface: IntIterable

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

Specified by:

reject in interface IntIterable

Specified by:

reject in interface MutableObjectIntMap<K>

detectIfNone

public int detectIfNone(IntPredicate predicate,
 int ifNone)

Specified by:

detectIfNone in interface IntIterable

collect

public <V1> MutableCollection<V1> collect(IntToObjectFunction<? extends V1> function)

Description copied from interface: IntIterable

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 IntIterable

Specified by:

collect in interface MutableObjectIntMap<K>

sum

public long sum()

Specified by:

sum in interface IntIterable

max

public int max()

Specified by:

max in interface IntIterable

maxIfEmpty

public int maxIfEmpty(int defaultValue)

Specified by:

maxIfEmpty in interface IntIterable

min

public int min()

Specified by:

min in interface IntIterable

minIfEmpty

public int minIfEmpty(int defaultValue)

Specified by:

minIfEmpty in interface IntIterable

average

public double average()

Specified by:

average in interface IntIterable

median

public double median()

Specified by:

median in interface IntIterable

toSortedArray

public int[] toSortedArray()

Specified by:

toSortedArray in interface IntIterable

toSortedList

public MutableIntList toSortedList()

Specified by:

toSortedList in interface IntIterable

toArray

public int[] toArray()

Description copied from interface: IntIterable

Converts the IntIterable to a primitive int array.

Specified by:

toArray in interface IntIterable

toArray

public int[] toArray(int[] target)

Description copied from interface: IntIterable

Converts the IntIterable to a primitive int 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 IntIterable

contains

public boolean contains(int value)

Description copied from interface: IntIterable

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

Specified by:

contains in interface IntIterable

containsAll

public boolean containsAll(int... source)

Description copied from interface: IntIterable

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

Specified by:

containsAll in interface IntIterable

containsAll

public boolean containsAll(IntIterable source)

Description copied from interface: IntIterable

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

Specified by:

containsAll in interface IntIterable

toList

public MutableIntList toList()

Description copied from interface: IntIterable

Converts the IntIterable to a new MutableIntList.

Specified by:

toList in interface IntIterable

toSet

public MutableIntSet toSet()

Description copied from interface: IntIterable

Converts the IntIterable to a new MutableIntSet.

Specified by:

toSet in interface IntIterable

toBag

public MutableIntBag toBag()

Description copied from interface: IntIterable

Converts the IntIterable to a new MutableIntBag.

Specified by:

toBag in interface IntIterable

asLazy

public LazyIntIterable asLazy()

Description copied from interface: IntIterable

Returns a LazyIntIterable adapter wrapping the source IntIterable.

Specified by:

asLazy in interface IntIterable

withKeyValue

public MutableObjectIntMap<K> withKeyValue(K key,
 int value)

Description copied from interface: MutableObjectIntMap

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

Parameters:

key - the key

value - the value to associate with value

Returns:

this map

See Also:

• MutableObjectIntMap.put(K, int)

withoutKey

public MutableObjectIntMap<K> withoutKey(K key)

Description copied from interface: MutableObjectIntMap

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

Specified by:

withoutKey in interface MutableObjectIntMap<K>

Parameters:

key - the key to remove

Returns:

this map

See Also:

• MutableObjectIntMap.remove(Object)

withoutAllKeys

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

Description copied from interface: MutableObjectIntMap

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

Specified by:

withoutAllKeys in interface MutableObjectIntMap<K>

Parameters:

keys - the keys to remove

Returns:

this map

See Also:

• MutableObjectIntMap.remove(Object)

asUnmodifiable

public MutableObjectIntMap<K> asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableObjectIntMap<K>

asSynchronized

public MutableObjectIntMap<K> asSynchronized()

Specified by:

asSynchronized in interface MutableObjectIntMap<K>

toImmutable

public ImmutableObjectIntMap<K> toImmutable()

Description copied from interface: ObjectIntMap

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

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

Returns:

a mutable set containing the keys in this map

values

public MutableIntCollection values()

Description copied from interface: ObjectIntMap

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

Returns:

the values as a collection backed by this map

keysView

public LazyIterable<K> keysView()

Description copied from interface: ObjectIntMap

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

Returns:

a view of the keys in this map

keyValuesView

public RichIterable<ObjectIntPair<K>> keyValuesView()

Description copied from interface: ObjectIntMap

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

Returns:

a view of the keys in this map

flipUniqueValues

public MutableIntObjectMap<K> flipUniqueValues()

Description copied from interface: ObjectIntMap

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

Specified by:

flipUniqueValues in interface MutableObjectIntMap<K>

Specified by:

flipUniqueValues in interface ObjectIntMap<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: ObjectIntMap

Follows the same general contract as AbstractMap.toString()

Specified by:

toString in interface ObjectIntMap<K>

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class Object

Returns:

a string representation of this ObjectIntMap

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,
 ObjectIntToObjectFunction<? super T,? extends T> function)

Specified by:

injectInto in interface IntIterable

chunk

public RichIterable<IntIterable> chunk(int size)

Description copied from interface: IntIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface IntIterable

Parameters:

size - the number of elements per chunk

Returns:

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