Enum Class EnvironmentVariablesSource
java.lang.Object
java.lang.Enum<EnvironmentVariablesSource>
io.fluxcapacitor.common.application.EnvironmentVariablesSource
- All Implemented Interfaces:
PropertySource
,Serializable
,Comparable<EnvironmentVariablesSource>
,Constable
public enum EnvironmentVariablesSource
extends Enum<EnvironmentVariablesSource>
implements PropertySource
A
PropertySource
that resolves property values from system environment variables.
This source accesses environment variables via System.getenv(String)
and can be used to inject configuration
values directly from the host operating system or container runtime.
This is typically used to override configuration in deployment environments without modifying application-specific property files.
Example usage
export FLUX_API_TOKEN=secret-tokenIn your application:
flux.api.token = ApplicationProperties.get("FLUX_API_TOKEN")
This source is usually combined with others (like ApplicationPropertiesSource
) in a layered
configuration strategy where environment variables take precedence.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Field Summary
Fields inherited from interface io.fluxcapacitor.common.application.PropertySource
substitutionPattern
-
Method Summary
Modifier and TypeMethodDescriptionRetrieves the value of the given property name from the system environment.static EnvironmentVariablesSource
Returns the enum constant of this class with the specified name.static EnvironmentVariablesSource[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Methods inherited from interface io.fluxcapacitor.common.application.PropertySource
andThen, containsProperty, get, getBoolean, getBoolean, require, substituteProperties
-
Enum Constant Details
-
INSTANCE
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
get
Retrieves the value of the given property name from the system environment.- Specified by:
get
in interfacePropertySource
- Parameters:
name
- the name of the environment variable- Returns:
- the value, or
null
if the variable is not defined
-