Package com.google.common.collect
Class ImmutableSortedMap.Builder<K,V>
java.lang.Object
com.google.common.collect.ImmutableMap.Builder<K,V>
com.google.common.collect.ImmutableSortedMap.Builder<K,V>
- Enclosing class:
ImmutableSortedMap<K,
V>
A builder for creating immutable sorted map instances, especially
public static final
maps ("constant maps"). Example:
static final ImmutableSortedMap<Integer, String> INT_TO_WORD =
new ImmutableSortedMap.Builder<Integer, String>(Ordering.natural())
.put(1, "one")
.put(2, "two")
.put(3, "three")
.build();
For small immutable sorted maps, the ImmutableSortedMap.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.
- Since:
- 2.0
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Returns a newly-created immutable sorted map.orderEntriesByValue
(Comparator<? super V> valueComparator) Deprecated.Unsupported by ImmutableSortedMap.Builder.Adds the givenentry
to the map, making it immutable if necessary.Associateskey
withvalue
in the built map.Adds all the given entries to the built map.Associates all of the given map's keys and values in the built map.
-
Constructor Details
-
Builder
Creates a new builder. The returned builder is equivalent to the builder generated byImmutableSortedMap.orderedBy(java.util.Comparator<K>)
.
-
-
Method Details
-
put
Associateskey
withvalue
in the built map. Duplicate keys, according to the comparator (which might be the keys' natural order), are not allowed, and will causebuild()
to fail.- Overrides:
put
in classImmutableMap.Builder<K,
V>
-
put
Adds the givenentry
to the map, making it immutable if necessary. Duplicate keys, according to the comparator (which might be the keys' natural order), are not allowed, and will causebuild()
to fail.- Overrides:
put
in classImmutableMap.Builder<K,
V> - Since:
- 11.0
-
putAll
Associates all of the given map's keys and values in the built map. Duplicate keys, according to the comparator (which might be the keys' natural order), are not allowed, and will causebuild()
to fail.- Overrides:
putAll
in classImmutableMap.Builder<K,
V> - Throws:
NullPointerException
- if any key or value inmap
is null
-
putAll
@Beta public ImmutableSortedMap.Builder<K,V> putAll(Iterable<? extends Map.Entry<? extends K, ? extends V>> entries) Adds all the given entries to the built map. Duplicate keys, according to the comparator (which might be the keys' natural order), are not allowed, and will causebuild()
to fail.- Overrides:
putAll
in classImmutableMap.Builder<K,
V> - Throws:
NullPointerException
- if any key, value, or entry is null- Since:
- 19.0
-
orderEntriesByValue
@Beta @Deprecated public ImmutableSortedMap.Builder<K,V> orderEntriesByValue(Comparator<? super V> valueComparator) Deprecated.Unsupported by ImmutableSortedMap.Builder.Throws anUnsupportedOperationException
.- Overrides:
orderEntriesByValue
in classImmutableMap.Builder<K,
V> - Since:
- 19.0
-
build
Returns a newly-created immutable sorted map.- Overrides:
build
in classImmutableMap.Builder<K,
V> - Throws:
IllegalArgumentException
- if any two keys are equal according to the comparator (which might be the keys' natural order)
-