@ProviderType
public final class ImmutableValueMap
extends java.lang.Object
implements org.apache.sling.api.resource.ValueMap
ValueMap
that does not support changing its content.
All methods that may change the content will throw a
UnsupportedOperationException
.
Static convenience methods provide similar behavior as Guava ImmutableMap variants.
Modifier and Type | Class and Description |
---|---|
static class |
ImmutableValueMap.Builder
Builder interface for
ImmutableValueMap . |
Modifier and Type | Method and Description |
---|---|
static @NotNull ImmutableValueMap.Builder |
builder()
Returns a new builder.
|
void |
clear()
Deprecated.
Unsupported operation
|
boolean |
containsKey(java.lang.Object key) |
boolean |
containsValue(java.lang.Object value) |
static @NotNull ImmutableValueMap |
copyOf(@NotNull java.util.Map<java.lang.String,java.lang.Object> map)
Returns an immutable map containing the same entries as
map . |
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> |
entrySet() |
boolean |
equals(java.lang.Object obj) |
java.lang.Object |
get(java.lang.Object key) |
<T> T |
get(@NotNull java.lang.String name,
@NotNull java.lang.Class<T> type) |
<T> T |
get(@NotNull java.lang.String name,
T defaultValue) |
int |
hashCode() |
boolean |
isEmpty() |
java.util.Set<java.lang.String> |
keySet() |
static @NotNull ImmutableValueMap |
of()
Returns the empty map.
|
static @NotNull ImmutableValueMap |
of(@NotNull java.lang.String k1,
@NotNull java.lang.Object v1)
Returns an immutable map containing a single entry.
|
static @NotNull ImmutableValueMap |
of(@NotNull java.lang.String k1,
@NotNull java.lang.Object v1,
@NotNull java.lang.String k2,
@NotNull java.lang.Object v2)
Returns an immutable map containing the given entries, in order.
|
static @NotNull ImmutableValueMap |
of(@NotNull java.lang.String k1,
@NotNull java.lang.Object v1,
@NotNull java.lang.String k2,
@NotNull java.lang.Object v2,
@NotNull java.lang.String k3,
@NotNull java.lang.Object v3)
Returns an immutable map containing the given entries, in order.
|
static @NotNull ImmutableValueMap |
of(@NotNull java.lang.String k1,
@NotNull java.lang.Object v1,
@NotNull java.lang.String k2,
@NotNull java.lang.Object v2,
@NotNull java.lang.String k3,
@NotNull java.lang.Object v3,
@NotNull java.lang.String k4,
@NotNull java.lang.Object v4)
Returns an immutable map containing the given entries, in order.
|
static ImmutableValueMap |
of(@NotNull java.lang.String k1,
@NotNull java.lang.Object v1,
@NotNull java.lang.String k2,
@NotNull java.lang.Object v2,
@NotNull java.lang.String k3,
@NotNull java.lang.Object v3,
@NotNull java.lang.String k4,
@NotNull java.lang.Object v4,
@NotNull java.lang.String k5,
@NotNull java.lang.Object v5)
Returns an immutable map containing the given entries, in order.
|
java.lang.Object |
put(java.lang.String key,
java.lang.Object value)
Deprecated.
Unsupported operation
|
void |
putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> m)
Deprecated.
Unsupported operation
|
java.lang.Object |
remove(java.lang.Object key)
Deprecated.
Unsupported operation
|
int |
size() |
java.lang.String |
toString() |
java.util.Collection<java.lang.Object> |
values() |
@Nullable public <T> T get(@NotNull @NotNull java.lang.String name, @NotNull @NotNull java.lang.Class<T> type)
get
in interface org.apache.sling.api.resource.ValueMap
@NotNull public <T> T get(@NotNull @NotNull java.lang.String name, @NotNull T defaultValue)
get
in interface org.apache.sling.api.resource.ValueMap
public int size()
size
in interface java.util.Map<java.lang.String,java.lang.Object>
public boolean isEmpty()
isEmpty
in interface java.util.Map<java.lang.String,java.lang.Object>
public boolean containsKey(java.lang.Object key)
containsKey
in interface java.util.Map<java.lang.String,java.lang.Object>
public boolean containsValue(java.lang.Object value)
containsValue
in interface java.util.Map<java.lang.String,java.lang.Object>
public java.lang.Object get(java.lang.Object key)
get
in interface java.util.Map<java.lang.String,java.lang.Object>
public java.util.Set<java.lang.String> keySet()
keySet
in interface java.util.Map<java.lang.String,java.lang.Object>
public java.util.Collection<java.lang.Object> values()
values
in interface java.util.Map<java.lang.String,java.lang.Object>
public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()
entrySet
in interface java.util.Map<java.lang.String,java.lang.Object>
public int hashCode()
hashCode
in interface java.util.Map<java.lang.String,java.lang.Object>
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in interface java.util.Map<java.lang.String,java.lang.Object>
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
@Deprecated public java.lang.Object put(java.lang.String key, java.lang.Object value)
put
in interface java.util.Map<java.lang.String,java.lang.Object>
@Deprecated public java.lang.Object remove(java.lang.Object key)
remove
in interface java.util.Map<java.lang.String,java.lang.Object>
@Deprecated public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> m)
putAll
in interface java.util.Map<java.lang.String,java.lang.Object>
@Deprecated public void clear()
clear
in interface java.util.Map<java.lang.String,java.lang.Object>
@NotNull public static @NotNull ImmutableValueMap of()
Collections.emptyMap()
, and is preferable mainly for consistency
and maintainability of your code.@NotNull public static @NotNull ImmutableValueMap of(@NotNull @NotNull java.lang.String k1, @NotNull @NotNull java.lang.Object v1)
Collections.singletonMap(K, V)
but will not
accept a null key or value. It is preferable mainly for consistency and
maintainability of your code.k1
- Key 1v1
- Value 1@NotNull public static @NotNull ImmutableValueMap of(@NotNull @NotNull java.lang.String k1, @NotNull @NotNull java.lang.Object v1, @NotNull @NotNull java.lang.String k2, @NotNull @NotNull java.lang.Object v2)
k1
- Key 1v1
- Value 1k2
- Key 2v2
- Value 2java.lang.IllegalArgumentException
- if duplicate keys are provided@NotNull public static @NotNull ImmutableValueMap of(@NotNull @NotNull java.lang.String k1, @NotNull @NotNull java.lang.Object v1, @NotNull @NotNull java.lang.String k2, @NotNull @NotNull java.lang.Object v2, @NotNull @NotNull java.lang.String k3, @NotNull @NotNull java.lang.Object v3)
k1
- Key 1v1
- Value 1k2
- Key 2v2
- Value 2k3
- Key 3v3
- Value 3java.lang.IllegalArgumentException
- if duplicate keys are provided@NotNull public static @NotNull ImmutableValueMap of(@NotNull @NotNull java.lang.String k1, @NotNull @NotNull java.lang.Object v1, @NotNull @NotNull java.lang.String k2, @NotNull @NotNull java.lang.Object v2, @NotNull @NotNull java.lang.String k3, @NotNull @NotNull java.lang.Object v3, @NotNull @NotNull java.lang.String k4, @NotNull @NotNull java.lang.Object v4)
k1
- Key 1v1
- Value 1k2
- Key 2v2
- Value 2k3
- Key 3v3
- Value 3k4
- Key 4v4
- Value 4java.lang.IllegalArgumentException
- if duplicate keys are providedpublic static ImmutableValueMap of(@NotNull @NotNull java.lang.String k1, @NotNull @NotNull java.lang.Object v1, @NotNull @NotNull java.lang.String k2, @NotNull @NotNull java.lang.Object v2, @NotNull @NotNull java.lang.String k3, @NotNull @NotNull java.lang.Object v3, @NotNull @NotNull java.lang.String k4, @NotNull @NotNull java.lang.Object v4, @NotNull @NotNull java.lang.String k5, @NotNull @NotNull java.lang.Object v5)
k1
- Key 1v1
- Value 1k2
- Key 2v2
- Value 2k3
- Key 3v3
- Value 3k4
- Key 4v4
- Value 4k5
- Key 5v5
- Value 5java.lang.IllegalArgumentException
- if duplicate keys are provided@NotNull public static @NotNull ImmutableValueMap.Builder builder()
ImmutableValueMap.Builder
constructor.@NotNull public static @NotNull ImmutableValueMap copyOf(@NotNull @NotNull java.util.Map<java.lang.String,java.lang.Object> map)
map
. If
map
somehow contains entries with duplicate keys (for example, if
it is a SortedMap
whose comparator is not consistent with
equals), the results of this method are undefined.
Despite the method name, this method attempts to avoid actually copying the data when it is safe to do so. The exact circumstances under which a copy will or will not be performed are undocumented and subject to change.
map
- Mapjava.lang.NullPointerException
- if any key or value in map
is nullCopyright © 2014–2021 wcm.io. All rights reserved.