com.force.i18n.commons.util.collection

Interface IntMap<V>

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractIntMap, IntHashMap

@Beta
public interface IntMap<V>
extends Serializable

A Map that uses ints as its keys. Mostly borrowed from java.util.HashMap

Also contains the public inner class interface IntMap.Entry that all implementations of IntMap must also complete. Beta class. Classes under com.force.i18n.commons package will be moved into a dedicated project.

Author:

Based on Sun's java.util.Map (modified by koliver)

See Also:

IntHashMap, IntSet

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IntMap.Entry<V>

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all mappings from this map.
boolean	containsKey(int key) Returns true if this map contains a mapping for the specified key.
boolean	containsValue(Object value) Returns true if this map maps one or more keys to the specified value.
Set<IntMap.Entry<V>>	entrySet() Returns a collection view of the mappings contained in this map.
V	get(int key) Returns the value to which this map maps the specified key.
boolean	isEmpty() Returns true if this map contains no key-value mappings.
IntSet	keySet() Returns a set view of the keys contained in this map.
V	put(int key, V value) Associates the specified value with the specified key in this map.
void	putAll(IntMap<? extends V> t) Copies all of the mappings from the specified map to this one.
V	remove(int key) Removes the mapping for this key from this map if present.
int	size() Returns the number of key-value mappings in this map.
Collection<V>	values() Returns a collection view of the values contained in this map.

Method Detail

size

int size()

Returns the number of key-value mappings in this map.

isEmpty

boolean isEmpty()

Returns true if this map contains no key-value mappings.

containsValue

boolean containsValue(Object value)

Returns true if this map maps one or more keys to the specified value.

Parameters:

value - value whose presence in this map is to be tested.

containsKey

boolean containsKey(int key)

Returns true if this map contains a mapping for the specified key.

Parameters:

key - key whose presence in this Map is to be tested.

get

V get(int key)

Returns the value to which this map maps the specified key. Returns null if the map contains no mapping for this key. A return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters:

key - key whose associated value is to be returned.

Returns:

the value to which this map maps the specified key.

put

V put(int key,
      V value)

Associates the specified value with the specified key in this map. If the map previously contained a mapping for this key, the old value is replaced.

Parameters:

key - key with which the specified value is to be associated.

value - value to be associated with the specified key.

Returns:

previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the HashMap previously associated null with the specified key.

remove

V remove(int key)

Removes the mapping for this key from this map if present.

Parameters:

key - key whose mapping is to be removed from the map.

Returns:

previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key.

putAll

void putAll(IntMap<? extends V> t)

Copies all of the mappings from the specified map to this one. These mappings replace any mappings that this map had for any of the keys currently in the specified Map.

Parameters:

t - Mappings to be stored in this map.

clear

void clear()

Removes all mappings from this map.

keySet

IntSet keySet()

Returns a set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. The set supports element removal, which removes the corresponding mapping from this map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:

a set view of the keys contained in this map.

values

Collection<V> values()

Returns a collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. The collection supports element removal, which removes the corresponding mapping from this map, via the Iterator.remove, Collection.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:

a collection view of the values contained in this map.

entrySet

Set<IntMap.Entry<V>> entrySet()

Returns a collection view of the mappings contained in this map. Each element in the returned collection is a IntMap.Entry. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:

a collection view of the mappings contained in this map.

See Also:

IntMap.Entry