MutableMap (Apache Brooklyn)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap<K,V>
  - - java.util.LinkedHashMap<K,V>
    - - brooklyn.util.collections.MutableMap<K,V>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<K,V>
```
public class MutableMap<K,V>
extends java.util.LinkedHashMap<K,V>
```
Map impl, exposing simple builder operations (add) in a fluent-style API, where the final map is mutable. You can also toImmutable.

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MutableMap.Builder<K,V>
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested Classes
Modifier and Type	Class and Description
`static class`	`MutableMap.Builder<K,V>`

Constructor Summary

Constructors
Constructor and Description

MutableMap()

MutableMap(java.util.Map source)

Constructors
Constructor and Description
`MutableMap()`
`MutableMap(java.util.Map source)`

Method Summary

Methods
Modifier and Type	Method and Description
`MutableMap<K,V>`	`add(K key, V value)` as `HashMap.put(Object, Object)` but fluent style
`MutableMap<K,V>`	`add(java.util.Map<? extends K,? extends V> m)` as `HashMap.putAll(Map)` but fluent style (and accepting null, ignoring it)
`MutableMap<K,V>`	`addIfNotNull(K key, V value)` as `HashMap.put(Object, Object)` but excluding null values, and fluent style
`java.util.Map<K,V>`	`asImmutableCopy()` as `MutableList.asImmutableCopy()`
`java.util.Map<K,V>`	`asUnmodifiable()` as `MutableList.asUnmodifiable()`
`java.util.Map<K,V>`	`asUnmodifiableCopy()` as `MutableList.asUnmodifiableCopy()`
`static <K,V> MutableMap.Builder<K,V>`	`builder()`
`static <K,V> MutableMap<K,V>`	`copyOf(java.util.Map<? extends K,? extends V> orig)`
`Maybe<V>`	`getMaybe(K key)`
`static <K,V> MutableMap<K,V>`	`of()`
`static <K,V> MutableMap<K,V>`	`of(K k1, V v1)`
`static <K,V> MutableMap<K,V>`	`of(K k1, V v1, K k2, V v2)`
`static <K,V> MutableMap<K,V>`	`of(K k1, V v1, K k2, V v2, K k3, V v3)`
`static <K,V> MutableMap<K,V>`	`of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)`
`static <K,V> MutableMap<K,V>`	`of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5)`
`static <K,V> MutableMap<K,V>`	`of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6)`
`static <K,V> MutableMap<K,V>`	`of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7)`
`com.google.common.collect.ImmutableMap<K,V>`	`toImmutable()` Deprecated. since 0.7.0, use `asImmutableCopy()`, or `asUnmodifiable()` / `asUnmodifiableCopy()`

Methods inherited from class java.util.LinkedHashMap
clear, containsValue, get

Methods inherited from class java.util.HashMap
clone, containsKey, entrySet, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap
equals, hashCode, toString

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

Methods inherited from interface java.util.Map
containsKey, entrySet, equals, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

MutableMap
```
public MutableMap()
```

MutableMap

public MutableMap(java.util.Map source)

Method Detail

of

public static <K,V> MutableMap<K,V> of()

of

public static <K,V> MutableMap<K,V> of(K k1,
                       V v1)

of

public static <K,V> MutableMap<K,V> of(K k1,
                       V v1,
                       K k2,
                       V v2)

of

public static <K,V> MutableMap<K,V> of(K k1,
                       V v1,
                       K k2,
                       V v2,
                       K k3,
                       V v3)

of

public static <K,V> MutableMap<K,V> of(K k1,
                       V v1,
                       K k2,
                       V v2,
                       K k3,
                       V v3,
                       K k4,
                       V v4)

of

public static <K,V> MutableMap<K,V> of(K k1,
                       V v1,
                       K k2,
                       V v2,
                       K k3,
                       V v3,
                       K k4,
                       V v4,
                       K k5,
                       V v5)

of

public static <K,V> MutableMap<K,V> of(K k1,
                       V v1,
                       K k2,
                       V v2,
                       K k3,
                       V v3,
                       K k4,
                       V v4,
                       K k5,
                       V v5,
                       K k6,
                       V v6)

of

public static <K,V> MutableMap<K,V> of(K k1,
                       V v1,
                       K k2,
                       V v2,
                       K k3,
                       V v3,
                       K k4,
                       V v4,
                       K k5,
                       V v5,
                       K k6,
                       V v6,
                       K k7,
                       V v7)

copyOf

public static <K,V> MutableMap<K,V> copyOf(@Nullable
                           java.util.Map<? extends K,? extends V> orig)

add

public MutableMap<K,V> add(K key,
                  V value)

as HashMap.put(Object, Object) but fluent style

add

public MutableMap<K,V> add(@Nullable
                  java.util.Map<? extends K,? extends V> m)

as HashMap.putAll(Map) but fluent style (and accepting null, ignoring it)

addIfNotNull

public MutableMap<K,V> addIfNotNull(K key,
                           V value)

as HashMap.put(Object, Object) but excluding null values, and fluent style

getMaybe
```
public Maybe<V> getMaybe(K key)
```

toImmutable
```
@Deprecated
public com.google.common.collect.ImmutableMap<K,V> toImmutable()
```
Deprecated. since 0.7.0, use asImmutableCopy(), or asUnmodifiable() / asUnmodifiableCopy()

asImmutableCopy
```
public java.util.Map<K,V> asImmutableCopy()
```
as MutableList.asImmutableCopy()

asUnmodifiable

public java.util.Map<K,V> asUnmodifiable()

as MutableList.asUnmodifiable()

asUnmodifiableCopy
```
public java.util.Map<K,V> asUnmodifiableCopy()
```
as MutableList.asUnmodifiableCopy()

builder

public static <K,V> MutableMap.Builder<K,V> builder()

Class MutableMap<K,V>

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Constructor Summary

Method Summary

Methods inherited from class java.util.LinkedHashMap

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

MutableMap

MutableMap

Method Detail

of

of

of

of

of

of

of

of

copyOf

add

add

addIfNotNull

getMaybe

toImmutable

asImmutableCopy

asUnmodifiable

asUnmodifiableCopy

builder