org.springframework.geode.core.env

Class EnvironmentMapAdapter

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.String>

org.springframework.geode.core.env.EnvironmentMapAdapter

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.String>

public class EnvironmentMapAdapter
extends java.util.AbstractMap<java.lang.String,java.lang.String>

Map implementation adapting an Environment object in order to use the Environment as a Map.

Since:

1.3.1

See Also:

Map, AbstractMap, Environment, PropertySource, Adapter Software Design Pattern

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	EnvironmentMapAdapter.EnvironmentEntry EnvironmentMapAdapter.EnvironmentEntry is a Map.Entry implementation mapping an Environment property (key) to its value.

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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
EnvironmentMapAdapter(org.springframework.core.env.Environment environment) Constructs a new instance of EnvironmentMapAdapter initialized with the given Environment.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.lang.Object key) Null-safe method determining whether the given key is a property in the underlying Environment.
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>	entrySet()
static EnvironmentMapAdapter	from(org.springframework.core.env.Environment environment) Factory method used to construct an new instance of EnvironmentMapAdapter initialized with the given Environment.
java.lang.String	get(java.lang.Object key) Gets the value for the property identified by the given Map key from the underlying Environment.
protected org.springframework.core.env.Environment	getEnvironment() Gets the configured Environment object being adapted by this Map.

Methods inherited from class java.util.AbstractMap

clear, clone, containsValue, equals, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

EnvironmentMapAdapter

public EnvironmentMapAdapter(@NonNull
                             org.springframework.core.env.Environment environment)

Constructs a new instance of EnvironmentMapAdapter initialized with the given Environment.

Parameters:

environment - Environment to adapt; must not be null.

Throws:

java.lang.IllegalArgumentException - if Environment is null.

See Also:

Environment

Method Detail

from

public static EnvironmentMapAdapter from(@NonNull
                                         org.springframework.core.env.Environment environment)

Factory method used to construct an new instance of EnvironmentMapAdapter initialized with the given Environment.

Parameters:

environment - Environment to adapt; must not be null.

Returns:

a new instance of EnvironmentMapAdapter for the given Environment.

Throws:

java.lang.IllegalArgumentException - if Environment is null.

See Also:

Environment, EnvironmentMapAdapter(Environment)

getEnvironment

@NonNull
protected org.springframework.core.env.Environment getEnvironment()

Gets the configured Environment object being adapted by this Map.

Returns:

the configured Environment; never null.

See Also:

Environment

containsKey

public boolean containsKey(@Nullable
                           java.lang.Object key)

Null-safe method determining whether the given key is a property in the underlying Environment.

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

containsKey in class java.util.AbstractMap<java.lang.String,java.lang.String>

Returns:

a boolean value indicating whether the given key is a property in the underlying Environment.

See Also:

PropertyResolver.containsProperty(String), getEnvironment()

get

@Nullable
public java.lang.String get(@Nullable
                                      java.lang.Object key)

Gets the value for the property identified by the given Map key from the underlying Environment.

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

get in class java.util.AbstractMap<java.lang.String,java.lang.String>

Parameters:

key - key identifying the property whose value will be retrieved from the Environment.

Returns:

the value of the property identified by the given Map key from the Environment.

See Also:

PropertyResolver.getProperty(String), getEnvironment()

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> entrySet()

Specified by:

entrySet in interface java.util.Map<java.lang.String,java.lang.String>

Specified by:

entrySet in class java.util.AbstractMap<java.lang.String,java.lang.String>