org.microbean.settings

Class EnvironmentVariablesSource

java.lang.Object

org.microbean.settings.Source

org.microbean.settings.EnvironmentVariablesSource

@ApplicationScoped
public class EnvironmentVariablesSource
extends Source

A Source that retrieves values from environment variables.

Author:

Laird Nelson

See Also:

getValue(String, Set)

Constructor Summary

Constructors

Constructor and Description
EnvironmentVariablesSource() Creates a new EnvironmentVariablesSource.

Method Summary

Modifier and Type	Method and Description
Value	getValue(String name, Set<Annotation> qualifiers) Returns a Value suitable for the supplied name by making use of the System.getenv(String) method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnvironmentVariablesSource

public EnvironmentVariablesSource()

Creates a new EnvironmentVariablesSource.

Method Detail

getValue

public Value getValue(String name,
                      Set<Annotation> qualifiers)

Returns a Value suitable for the supplied name by making use of the System.getenv(String) method.

Specified by:

getValue in class Source

Parameters:

name - the name of the setting; must not be null

qualifiers - a Set of Annotations qualifying the request; the Value returned by this method will have a subset of these qualifiers; must not be null

Returns:

a suitable Value, or null if an invocation of System.getenv(String) with the supplied name returns null

Throws:

NullPointerException - if either name or qualifiers is null

Idempotency:

No guarantees with respect to idempotency are made about this method.

Nullability:

This method may return null.

Thread Safety:

This method is safe for concurrent use by multiple threads.