Class TwoDHashMap<K1,K2,V>

java.lang.Object
org.supercsv.util.TwoDHashMap<K1,K2,V>
Type Parameters:
K1 - the first key type
K2 - the second key type
V - the value type
public class TwoDHashMap<K1,K2,V> extends Object
A two-dimensional hashmap, is a HashMap that enables you to refer to values via two keys rather than one. The underlying implementation is simply a HashMap containing HashMap, each of which maps to values.
Since:
2.0.0 (migrated from Spiffy 0.5)
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final HashMap<K1, HashMap<K2,V>>
    map
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    TwoDHashMap()
    Constructs a new TwoDHashMap.
    TwoDHashMap(HashMap<K1, HashMap<K2,V>> map)
    Constructs a new TwoDHashMap using the supplied map.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsKey(K1 firstKey, K2 secondKey)
    Existence check of a value (or null) mapped to the keys.
    V
    get(K1 firstKey, K2 secondKey)
    Fetch a value from the Hashmap .
    Set<K1>
    keySet()
    Returns a set of the keys of the outermost map.
    Object
    set(K1 firstKey, K2 secondKey, V value)
    Insert a value
    int
    size()
    Returns the number of key-value mappings in this map for the first key.
    int
    size(K1 firstKey)
    Returns the number of key-value mappings in this map for the second key.

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • TwoDHashMap

      public TwoDHashMap()
      Constructs a new TwoDHashMap.

    • TwoDHashMap

      public TwoDHashMap(HashMap<K1, HashMap<K2,V>> map)
      Constructs a new TwoDHashMap using the supplied map.
      Parameters:
      map - the map
      Throws:
      NullPointerException - if map is null

  • Method Details

    • containsKey

      public boolean containsKey(K1 firstKey, K2 secondKey)
      Existence check of a value (or null) mapped to the keys.
      Parameters:
      firstKey - first key
      secondKey - second key
      Returns:
      true when an element (or null) has been stored with the keys

    • get

      public V get(K1 firstKey, K2 secondKey)
      Fetch a value from the Hashmap .
      Parameters:
      firstKey - first key
      secondKey - second key
      Returns:
      the element or null.

    • set

      public Object set(K1 firstKey, K2 secondKey, V value)
      Insert a value
      Parameters:
      firstKey - first key
      secondKey - second key
      value - the value to be inserted. null may be inserted as well.
      Returns:
      null or the value the insert is replacing.

    • size

      public int size()
      Returns the number of key-value mappings in this map for the first key.
      Returns:
      Returns the number of key-value mappings in this map for the first key.

    • size

      public int size(K1 firstKey)
      Returns the number of key-value mappings in this map for the second key.
      Parameters:
      firstKey - the first key
      Returns:
      Returns the number of key-value mappings in this map for the second key.

    • keySet

      public Set<K1> keySet()
      Returns a set of the keys of the outermost map.
      Returns:
      the key set for the outermost map