OptMapImpl (util-map 0.1.0 API)

java.lang.Object
- de.tudresden.inf.lat.util.map.OptMapImpl<K,V>

Type Parameters:

K - type of keys in this map

V - type of mapped values

All Implemented Interfaces:

OptMap<K,V>
```
public class OptMapImpl<K,V>
extends Object
implements OptMap<K,V>
```
This is the default implementation of OptMap. This implementation does not copy the map passed as an argument to create the instance, and it uses the map itself instead. This means that the internal representation can be modified externally, or it can be retrieved by using asMap().

Author:

Julian Mendez

See Also:

OptMap

Constructor Summary

Constructors
Constructor and Description
`OptMapImpl()` Constructs a new map.
`OptMapImpl(Map<K,V> map)` Constructs a new map using a specified `Map`.
`OptMapImpl(OptMap<K,V> map)` Constructs a new map using another specified `OptMap`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<K,V>`	`asMap()` Returns this as a `Map`.
`void`	`clear()` Clears this map.
`boolean`	`containsKey(K key)` Returns `true` if and only if this map contains a mapping for the given key.
`boolean`	`containsValue(V value)` Returns `true` if and only if this map associates one or more keys to the given value.
`Set<Map.Entry<K,V>>`	`entrySet()` Returns a set of associations.
`boolean`	`equals(Object obj)`
`Optional<V>`	`get(K key)` Returns an optional containing the value associated to the given key, is this association exists, or an empty optional otherwise.
`int`	`hashCode()`
`boolean`	`isEmpty()` Returns `true` if and only if this map is empty.
`Set<K>`	`keySet()` Returns the set of keys.
`Optional<V>`	`put(K key, V value)` Associates the given value with the given key.
`void`	`putAll(Map<? extends K,? extends V> m)` Adds all the associations given in the specified map.
`Optional<V>`	`remove(K key)` Removes the mapping for the given key.
`int`	`size()` Returns the size of this map.
`String`	`toString()`
`Collection<V>`	`values()` Returns the collection of values.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OptMapImpl
```
public OptMapImpl()
```
    Constructs a new map. The default implementation structure is a HashMap.
  - OptMapImpl
```
public OptMapImpl(Map<K,V> map)
```
    Constructs a new map using a specified Map.
    
    Parameters:
    
    map - map
  - OptMapImpl
```
public OptMapImpl(OptMap<K,V> map)
```
    Constructs a new map using another specified OptMap.
    
    Parameters:
    
    map - map
- Method Detail
  - size
```
public int size()
```
    Description copied from interface: OptMap
    
    Returns the size of this map.
    
    Specified by:
    
    size in interface OptMap<K,V>
    
    Returns:
    
    the size of this map
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: OptMap
    
    Returns true if and only if this map is empty.
    
    Specified by:
    
    isEmpty in interface OptMap<K,V>
    
    Returns:
    
    true if and only if this map is empty
  - containsKey
```
public boolean containsKey(K key)
```
    Description copied from interface: OptMap
    
    Returns true if and only if this map contains a mapping for the given key. This method replaces Map.containsKey(Object).
    
    Specified by:
    
    containsKey in interface OptMap<K,V>
    
    Parameters:
    
    key - key
    
    Returns:
    
    true if and only if this map contains a mapping for the given key
  - containsValue
```
public boolean containsValue(V value)
```
    Description copied from interface: OptMap
    
    Returns true if and only if this map associates one or more keys to the given value. This method replaces Map.containsValue(Object).
    
    Specified by:
    
    containsValue in interface OptMap<K,V>
    
    Parameters:
    
    value - value
    
    Returns:
    
    true if and only if this map associates one or more keys to the given value
  - get
```
public Optional<V> get(K key)
```
    Description copied from interface: OptMap
    
    Returns an optional containing the value associated to the given key, is this association exists, or an empty optional otherwise. This method replaces Map.get(Object).
    
    Specified by:
    
    get in interface OptMap<K,V>
    
    Parameters:
    
    key - key
    
    Returns:
    
    an optional containing the value associated to the given key, is this association exists, or an empty optional otherwise
  - put
```
public Optional<V> put(K key,
                       V value)
```
    Description copied from interface: OptMap
    
    Associates the given value with the given key. This method replaces put(K, V).
    
    Specified by:
    
    put in interface OptMap<K,V>
    
    Parameters:
    
    key - key
    
    value - value
    
    Returns:
    
    an optional containing the previous associated value for the given key, or an empty optional if there was no mapping for that key
  - remove
```
public Optional<V> remove(K key)
```
    Description copied from interface: OptMap
    
    Removes the mapping for the given key. This method replaces Map.remove(Object).
    
    Specified by:
    
    remove in interface OptMap<K,V>
    
    Parameters:
    
    key - key
    
    Returns:
    
    an optional containing the previous associated value for the given key, or an empty optional if there was no mapping for that key
  - putAll
```
public void putAll(Map<? extends K,? extends V> m)
```
    Description copied from interface: OptMap
    
    Adds all the associations given in the specified map.
    
    Specified by:
    
    putAll in interface OptMap<K,V>
    
    Parameters:
    
    m - map containing associations
  - clear
```
public void clear()
```
    Description copied from interface: OptMap
    
    Clears this map.
    
    Specified by:
    
    clear in interface OptMap<K,V>
  - keySet
```
public Set<K> keySet()
```
    Description copied from interface: OptMap
    
    Returns the set of keys.
    
    Specified by:
    
    keySet in interface OptMap<K,V>
    
    Returns:
    
    the set of keys
  - values
```
public Collection<V> values()
```
    Description copied from interface: OptMap
    
    Returns the collection of values.
    
    Specified by:
    
    values in interface OptMap<K,V>
    
    Returns:
    
    the collection of values
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    Description copied from interface: OptMap
    
    Returns a set of associations.
    
    Specified by:
    
    entrySet in interface OptMap<K,V>
    
    Returns:
    
    a set of associations
  - asMap
```
public Map<K,V> asMap()
```
    Description copied from interface: OptMap
    
    Returns this as a Map.
    
    Specified by:
    
    asMap in interface OptMap<K,V>
    
    Returns:
    
    this as a Map
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class OptMapImpl<K,V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OptMapImpl

OptMapImpl

OptMapImpl

Method Detail

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet

asMap

equals

hashCode

toString