Modifier and Type | Class and Description |
---|---|
static class |
ConfigurationParameters.Milliseconds
Helper class for configuration parameters that denote a "duration", such
as a timeout or expiration time.
|
Modifier and Type | Field and Description |
---|---|
static ConfigurationParameters |
EMPTY
An empty configuration parameters
|
Modifier and Type | Method and Description |
---|---|
void |
clear() |
boolean |
contains(@NotNull String key)
Returns
true if this instance contains a configuration entry with
the specified key irrespective of the defined value; false otherwise. |
boolean |
containsKey(Object key) |
boolean |
containsValue(Object value) |
@NotNull Set<Map.Entry<String,Object>> |
entrySet() |
Object |
get(Object key) |
<T> T |
getConfigValue(@NotNull String key,
T defaultValue)
Returns the value of the configuration entry with the given
key
applying the following rules:
If this instance doesn't contain a configuration entry with that
key, or if the entry is null , the specified defaultValue will be returned.
If the configured value is not null an attempt is made to convert the configured value to
match the type of the default value.
|
<T> T |
getConfigValue(@NotNull String key,
T defaultValue,
@Nullable Class<T> targetClass)
Returns the value of the configuration entry with the given
key
applying the following rules:
If this instance doesn't contain a configuration entry with that
key the specified defaultValue will be returned.
If defaultValue is null the original value will
be returned.
If the configured value is null this method will always
return null .
If neither defaultValue nor the configured value is
null an attempt is made to convert the configured value to
match the type of the default value.
|
boolean |
isEmpty() |
@NotNull Set<String> |
keySet() |
static @NotNull ConfigurationParameters |
of(ConfigurationParameters... params)
Creates a new configuration parameters instance by merging all
params sequentially. |
static @NotNull ConfigurationParameters |
of(@NotNull Dictionary<String,Object> properties)
Creates new a configuration parameters instance by copying the given properties.
|
static @NotNull ConfigurationParameters |
of(@NotNull Map<?,?> map)
Creates new a configuration parameters instance by copying the given map.
|
static @NotNull ConfigurationParameters |
of(@NotNull Properties properties)
Creates new a configuration parameters instance by copying the given properties.
|
static @NotNull ConfigurationParameters |
of(@NotNull String key,
@NotNull Object value)
Creates new a single valued configuration parameters instance from the
given key and value.
|
static @NotNull ConfigurationParameters |
of(@NotNull String key1,
@NotNull Object value1,
@NotNull String key2,
@NotNull Object value2)
Creates new a configuration parameters instance from the
given key and value pairs.
|
Object |
put(String key,
Object value) |
void |
putAll(@NotNull Map<? extends String,?> m) |
Object |
remove(Object key) |
int |
size() |
@NotNull Collection<Object> |
values() |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll
public static final ConfigurationParameters EMPTY
@NotNull public static @NotNull ConfigurationParameters of(@NotNull ConfigurationParameters... params)
params
sequentially.
I.e. property define in subsequent arguments overwrite the ones before.params
- source parameters to mergeEMPTY
if all source params were empty.@NotNull public static @NotNull ConfigurationParameters of(@NotNull @NotNull Properties properties)
properties
- source propertiesEMPTY
if the source properties were empty.@NotNull public static @NotNull ConfigurationParameters of(@NotNull @NotNull Dictionary<String,Object> properties)
properties
- source propertiesEMPTY
if the source properties were empty.@NotNull public static @NotNull ConfigurationParameters of(@NotNull @NotNull Map<?,?> map)
map
- source mapEMPTY
if the source map was empty.@NotNull public static @NotNull ConfigurationParameters of(@NotNull @NotNull String key, @NotNull @NotNull Object value)
key
- The keyvalue
- The value@NotNull public static @NotNull ConfigurationParameters of(@NotNull @NotNull String key1, @NotNull @NotNull Object value1, @NotNull @NotNull String key2, @NotNull @NotNull Object value2)
key1
- The key of the first pair.value1
- The value of the first pairkey2
- The key of the second pair.value2
- The value of the second pair.public boolean contains(@NotNull @NotNull String key)
true
if this instance contains a configuration entry with
the specified key irrespective of the defined value; false
otherwise.key
- The key to be tested.true
if this instance contains a configuration entry with
the specified key irrespective of the defined value; false
otherwise.@Nullable public <T> T getConfigValue(@NotNull @NotNull String key, @Nullable T defaultValue, @Nullable @Nullable Class<T> targetClass)
key
applying the following rules:
defaultValue
will be returned.defaultValue
is null
the original value will
be returned.null
this method will always
return null
.defaultValue
nor the configured value is
null
an attempt is made to convert the configured value to
match the type of the default value.key
- The name of the configuration option.defaultValue
- The default value to return if no such entry exists
or to use for conversion.targetClass
- The target classnull
.@NotNull public <T> T getConfigValue(@NotNull @NotNull String key, @NotNull T defaultValue)
key
applying the following rules:
null
, the specified defaultValue
will be returned.null
an attempt is made to convert the configured value to
match the type of the default value.key
- The name of the configuration option.defaultValue
- The default value to return if no such entry exists
or to use for conversion.null
.public boolean containsKey(Object key)
containsKey
in interface Map<String,Object>
public boolean containsValue(Object value)
containsValue
in interface Map<String,Object>
@NotNull public @NotNull Collection<Object> values()
Copyright © 2010 - 2020 Adobe. All Rights Reserved