com.cloudhopper.commons.util

Interface SimpleMap<V>

All Known Implementing Classes:

DigitLookupMap, StringLookupMap

public interface SimpleMap<V>

A more simplified map interface than a java.util.Map where only a small subset of functionality is supported.

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Method Summary

Methods

Modifier and Type	Method and Description
V	get(String key) Returns the value to which this map maps the specified key.
V	put(String key, V value) Associates the specified value with the specified key in this map.
int	size() Returns the number of key-value mappings in this map.

Method Detail

get

V get(String key)
      throws IllegalArgumentException

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.
More formally, if this map contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

Parameters:

key - The key whose associated value is to be returned.

Returns:

The value to which this map maps the specified key, or null if the map contains no mapping for this key.

Throws:

IllegalArgumentException - Thrown if the key or value is not valid

put

V put(String key,
    V value)
      throws IllegalArgumentException

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 by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Parameters:

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

value - The value to be associated with the specified key.

Returns:

The 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, if the implementation supports null values.

Throws:

IllegalArgumentException - Thrown if the key or value is not valid

size

int size()

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

Returns:

The number of key-value mappings in this map.