|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.google.common.collect.ImmutableMap.Builder<K,V>
public static class ImmutableMap.Builder<K,V>
A builder for creating immutable map instances, especially public
static final maps ("constant maps"). Example:
static final ImmutableMap<String, Integer> WORD_TO_INT =
new ImmutableMap.Builder<String, Integer>()
.put("one", 1)
.put("two", 2)
.put("three", 3)
.build();
For small immutable maps, the ImmutableMap.of() methods are
even more convenient.
Builder instances can be reused - it is safe to call build()
multiple times to build multiple maps in series. Each map is a superset of
the maps created before it.
| Constructor Summary | |
|---|---|
ImmutableMap.Builder()
Creates a new builder. |
|
| Method Summary | |
|---|---|
ImmutableMap<K,V> |
build()
Returns a newly-created immutable map. |
ImmutableMap.Builder<K,V> |
put(K key,
V value)
Associates key with value in the built map. |
ImmutableMap.Builder<K,V> |
put(Map.Entry<? extends K,? extends V> entry)
Adds the given entry to the map, making it immutable if
necessary. |
ImmutableMap.Builder<K,V> |
putAll(Map<? extends K,? extends V> map)
Associates all of the given map's keys and values in the built map. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ImmutableMap.Builder()
ImmutableMap.builder().
| Method Detail |
|---|
public ImmutableMap.Builder<K,V> put(K key,
V value)
key with value in the built map. Duplicate
keys are not allowed, and will cause build() to fail.
public ImmutableMap.Builder<K,V> put(Map.Entry<? extends K,? extends V> entry)
entry to the map, making it immutable if
necessary. Duplicate keys are not allowed, and will cause build()
to fail.
public ImmutableMap.Builder<K,V> putAll(Map<? extends K,? extends V> map)
build() to fail.
NullPointerException - if any key or value in map is nullpublic ImmutableMap<K,V> build()
IllegalArgumentException - if duplicate keys were added
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||