Package org.eclipse.microprofile.config
Interface ConfigValue
public interface ConfigValue
The ConfigValue holds additional information after the lookup of a configuration property and is itself immutable.
Holds information about the configuration property name, configuration value, the
ConfigSource
name from where the configuration property was loaded and
the ordinal of the ConfigSource
.
This is used together with Config
to expose the configuration property lookup metadata.
- Since:
- 2.0
-
Method Summary
Modifier and TypeMethodDescriptiongetName()
The name of the property.The value of the property lookup without any transformation (expanded , etc).TheConfigSource
name that loaded the property lookup.int
TheConfigSource
ordinal that loaded the property lookup.getValue()
The value of the property lookup with transformations (expanded, etc).
-
Method Details
-
getName
String getName()The name of the property.- Returns:
- the name of the property.
-
getValue
String getValue()The value of the property lookup with transformations (expanded, etc).- Returns:
- the value of the property lookup or
null
if the property could not be found
-
getRawValue
String getRawValue()The value of the property lookup without any transformation (expanded , etc).- Returns:
- the raw value of the property lookup or
null
if the property could not be found.
-
getSourceName
String getSourceName()TheConfigSource
name that loaded the property lookup.- Returns:
- the ConfigSource name that loaded the property lookup or
null
if the property could not be found
-
getSourceOrdinal
int getSourceOrdinal()TheConfigSource
ordinal that loaded the property lookup.- Returns:
- the ConfigSource ordinal that loaded the property lookup or
0
if the property could not be found
-