ExtMap (ovirt-engine-extensions-api 0.0.0 API)

java.lang.Object
- org.ovirt.engine.api.extensions.ExtMap

All Implemented Interfaces:

Serializable, Cloneable, ConcurrentMap<ExtKey,Object>, Map<ExtKey,Object>
```
public class ExtMap
extends Object
implements ConcurrentMap<ExtKey,Object>, Cloneable, Serializable
```
Type safe map. Keys are bundle of uuid and type, each value added is checked against key type.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description
`ExtMap()` Constructs an empty ExtMap with the default initial capacity (16) and the default load factor (0.75).
`ExtMap(int initialCapacity)` Constructs an empty ExtMap with the specified initial capacity and the default load factor (0.75).
`ExtMap(int initialCapacity, float loadFactor)` Constructs an empty ExtMap with the specified initial capacity and load factor.
`ExtMap(Map<ExtKey,Object> m)` Constructs a new ExtMap with the same mappings as the specified Map.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`ExtMap`	`clone()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Set<Map.Entry<ExtKey,Object>>`	`entrySet()`
`boolean`	`equals(Object obj)`
`<T> T`	`get(ExtKey key)` Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
`<T> T`	`get(ExtKey key, Class<T> type)` Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
`<T> T`	`get(ExtKey key, Class<T> type, T defaultValue)` Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
`<T> T`	`get(ExtKey key, Object defaultValue)` Returns the value to which the specified key is mapped, or default.
`Object`	`get(Object key)`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`Set<ExtKey>`	`keySet()`
`ExtMap`	`mput(ExtKey key, Object value)` Multiple put.
`ExtMap`	`mput(Map<? extends ExtKey,? extends Object> m)` Multiple putAll.
`Object`	`put(ExtKey key, Object value)`
`void`	`putAll(Map<? extends ExtKey,? extends Object> m)`
`Object`	`putIfAbsent(ExtKey key, Object value)`
`Object`	`remove(Object key)`
`boolean`	`remove(Object key, Object value)`
`Object`	`replace(ExtKey key, Object value)`
`boolean`	`replace(ExtKey key, Object oldValue, Object newValue)`
`int`	`size()`
`String`	`toString()`
`Collection<Object>`	`values()`

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

Methods inherited from interface java.util.concurrent.ConcurrentMap
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, replaceAll

- Constructor Detail
  - ExtMap
```
public ExtMap(int initialCapacity,
              float loadFactor)
```
    Constructs an empty ExtMap with the specified initial capacity and load factor.
    
    Parameters:
    
    initialCapacity - the initial capacity.
    
    loadFactor - the load factor.
    
    Throws:
    
    IllegalArgumentException - if the initial capacity is negative or the load factor is nonpositive.
  - ExtMap
```
public ExtMap(int initialCapacity)
```
    Constructs an empty ExtMap with the specified initial capacity and the default load factor (0.75).
    
    Parameters:
    
    initialCapacity - the initial capacity.
    
    Throws:
    
    IllegalArgumentException - if the initial capacity is negative or the load factor is nonpositive.
  - ExtMap
```
public ExtMap()
```
    Constructs an empty ExtMap with the default initial capacity (16) and the default load factor (0.75).
  - ExtMap
```
public ExtMap(Map<ExtKey,Object> m)
```
    Constructs a new ExtMap with the same mappings as the specified Map. The ExtMap is created with default load factor (0.75) and an initial capacity sufficient to hold the mappings in the specified Map.
    
    Parameters:
    
    m - the map whose mappings are to be placed in this map.
    
    Throws:
    
    NullPointerException - if the specified map is null.
- Method Detail
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface Map<ExtKey,Object>
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map<ExtKey,Object>
    
    Overrides:
    
    hashCode in class Object
  - clone
```
public ExtMap clone()
```
    Overrides:
    
    clone in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<ExtKey,Object>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<ExtKey,Object>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<ExtKey,Object>
  - entrySet
```
public Set<Map.Entry<ExtKey,Object>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<ExtKey,Object>
  - get
```
public Object get(Object key)
```
    Specified by:
    
    get in interface Map<ExtKey,Object>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<ExtKey,Object>
  - keySet
```
public Set<ExtKey> keySet()
```
    Specified by:
    
    keySet in interface Map<ExtKey,Object>
  - put
```
public Object put(ExtKey key,
                  Object value)
```
    Specified by:
    
    put in interface Map<ExtKey,Object>
  - putAll
```
public void putAll(Map<? extends ExtKey,? extends Object> m)
```
    Specified by:
    
    putAll in interface Map<ExtKey,Object>
  - remove
```
public Object remove(Object key)
```
    Specified by:
    
    remove in interface Map<ExtKey,Object>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<ExtKey,Object>
  - values
```
public Collection<Object> values()
```
    Specified by:
    
    values in interface Map<ExtKey,Object>
  - putIfAbsent
```
public Object putIfAbsent(ExtKey key,
                          Object value)
```
    Specified by:
    
    putIfAbsent in interface ConcurrentMap<ExtKey,Object>
    
    Specified by:
    
    putIfAbsent in interface Map<ExtKey,Object>
  - remove
```
public boolean remove(Object key,
                      Object value)
```
    Specified by:
    
    remove in interface ConcurrentMap<ExtKey,Object>
    
    Specified by:
    
    remove in interface Map<ExtKey,Object>
  - replace
```
public Object replace(ExtKey key,
                      Object value)
```
    Specified by:
    
    replace in interface ConcurrentMap<ExtKey,Object>
    
    Specified by:
    
    replace in interface Map<ExtKey,Object>
  - replace
```
public boolean replace(ExtKey key,
                       Object oldValue,
                       Object newValue)
```
    Specified by:
    
    replace in interface ConcurrentMap<ExtKey,Object>
    
    Specified by:
    
    replace in interface Map<ExtKey,Object>
  - mput
```
public ExtMap mput(ExtKey key,
                   Object value)
```
    Multiple put. Usable for adding multiple entries:
```
 ExtMap = new ExtMap().mput(key1, value1).mput(key2, value2);
 
```
    Parameters:
    
    key - key with which the specified value is to be associated.
    
    value - value to be associated with the specified key.
    
    Returns:
    
    this.
  - mput
```
public ExtMap mput(Map<? extends ExtKey,? extends Object> m)
```
    Multiple putAll. Usable for adding multiple entries:
```
 ExtMap = new ExtMap().mputAll(map1).mputAll(map2);
 
```
    Parameters:
    
    m - map to add.
    
    Returns:
    
    this.
  - get
```
public <T> T get(ExtKey key,
                 Class<T> type,
                 T defaultValue)
```
    Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key. Safe version of get().
```
 Integer i = <Integer> map.get(key1, Integer);
 
```
    Type Parameters:
    
    T - type of return and default value, inferred
    
    Parameters:
    
    key - key with which the specified value is to be associated.
    
    type - expected type.
    
    defaultValue - default value to return.
    
    Returns:
    
    Value.
  - get
```
public <T> T get(ExtKey key,
                 Class<T> type)
```
    Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key. Safe version of get().
    
    Type Parameters:
    
    T - type of return value, inferred
    
    Parameters:
    
    key - key with which the specified value is to be associated.
    
    type - expected type.
    
    Returns:
    
    Value.
    
    See Also:
    
    get(ExtKey key, Class type, Object defaultValue)
  - get
```
public <T> T get(ExtKey key)
```
    Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key. Unsafe method of get with cast.
```
 Integer i = <Integer> map.get(key1);
 
```
    Type Parameters:
    
    T - type of return value
    
    Parameters:
    
    key - key.
    
    Returns:
    
    Value.
  - get
```
public <T> T get(ExtKey key,
                 Object defaultValue)
```
    Returns the value to which the specified key is mapped, or default. Unsafe method of get with cast.
```
 Integer i = <Integer> map.get(key1, 5);
 
```
    Type Parameters:
    
    T - type of return and default value, inferred
    
    Parameters:
    
    key - key.
    
    defaultValue - default value.
    
    Returns:
    
    Value.

Class ExtMap

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.concurrent.ConcurrentMap

Constructor Detail

ExtMap

ExtMap

ExtMap

ExtMap

Method Detail

equals

hashCode

clone

toString

clear

containsKey

containsValue

entrySet

get

isEmpty

keySet

put

putAll

remove

size

values

putIfAbsent

remove

replace

replace

mput

mput

get

get

get

get