edu.ucla.sspace.util.primitive

Interface IntIntMultiMap

All Superinterfaces:

MultiMap<Integer,Integer>

All Known Implementing Classes:

IntIntHashMultiMap

public interface IntIntMultiMap
extends MultiMap<Integer,Integer>

A MultiMap subinterface for mapping int primitives as both keys and values.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsKey(int key) Returns true if this multi-map contains a mapping for the specified key.
boolean	containsMapping(int key, int value) Returns true if this multi-map contains a mapping from specified key to the specified value.
boolean	containsValue(int key) Returns true if this multi-map contains from any key to the specified value.
IntSet	get(int key) Returns the set of values mapped to this key or null of the key is not mapped to any values
IntSet	keySet() Returns a Set view of the mappings contained in this multi-map.
boolean	put(int key, int value) Adds the specified value to the set of values associated with the specified key in this map.
void	putAll(IntIntMultiMap m) Copies all of the mappings from the specified map to this mutli-map
boolean	putMany(int key, Collection<Integer> values) Adds all of the specified values to the set of values associated with the specified key in this map.
boolean	putMany(int key, IntCollection values) Adds all of the specified values to the set of values associated with the specified key in this map.
IntSet	remove(int key) Removes the mapping for a key from this multi-map if it is present
boolean	remove(int key, int value) Removes the specified mapping for a key if it is present.
IntCollection	values() Returns a Collection view of the values contained in this map.

Methods inherited from interface edu.ucla.sspace.util.MultiMap

asMap, clear, containsKey, containsMapping, containsValue, entrySet, get, isEmpty, put, putAll, putAll, putMany, range, remove, remove, size, valueSets

Method Detail

containsKey

boolean containsKey(int key)

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

containsMapping

boolean containsMapping(int key,
                      int value)

Returns true if this multi-map contains a mapping from specified key to the specified value.

containsValue

boolean containsValue(int key)

Returns true if this multi-map contains from any key to the specified value.

get

IntSet get(int key)

Returns the set of values mapped to this key or null of the key is not mapped to any values

keySet

IntSet keySet()

Returns a Set view of the mappings contained in this multi-map.

Specified by:

keySet in interface MultiMap<Integer,Integer>

put

boolean put(int key,
          int value)

Adds the specified value to the set of values associated with the specified key in this map.

Parameters:

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

value - a value to be associated with the specified key

Returns:

true if the provided value was not already in the set of value mapped to the specified key

putAll

void putAll(IntIntMultiMap m)

Copies all of the mappings from the specified map to this mutli-map

putMany

boolean putMany(int key,
              IntCollection values)

Adds all of the specified values to the set of values associated with the specified key in this map.

Parameters:

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

values - a collection of values to be associated with the specified key

Returns:

true if at least one of the provided value was not already in the set of value mapped to the specified key

putMany

boolean putMany(int key,
              Collection<Integer> values)

Adds all of the specified values to the set of values associated with the specified key in this map.

Parameters:

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

values - a collection of values to be associated with the specified key

Returns:

true if at least one of the provided value was not already in the set of value mapped to the specified key

remove

IntSet remove(int key)

Removes the mapping for a key from this multi-map if it is present

remove

boolean remove(int key,
             int value)

Removes the specified mapping for a key if it is present. If the key is mapped to other values, it is retained, otherwise the key is removed from the map. This method provides a way to remove a specific mapping for a key without removing all other existing mappings.

Returns:

true if the specified mapping was removed

values

IntCollection values()

Returns a Collection view of the values contained in this map.

Specified by:

values in interface MultiMap<Integer,Integer>