Top Description Methods
org.eclipse.microprofile.config

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 org.eclipse.microprofile.config.spi.ConfigSource name from where the configuration property was loaded and the ordinal of the org.eclipse.microprofile.config.spi.ConfigSource.

This is used together with Config to expose the configuration property lookup metadata.

Author
Roberto Cortez
Since
2.0

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the name of the property.
getName
()

The name of the property.

public String

Returns:

the raw value of the property lookup or null if the property could not be found.
getRawValue
()

The value of the property lookup without any transformation (expanded , etc).

public String

Returns:

the ConfigSource name that loaded the property lookup or null if the property could not be found
getSourceName
()

The org.eclipse.microprofile.config.spi.ConfigSource name that loaded the property lookup.

public int

Returns:

the ConfigSource ordinal that loaded the property lookup or 0 if the property could not be found
getSourceOrdinal
()

The org.eclipse.microprofile.config.spi.ConfigSource ordinal that loaded the property lookup.

public String

Returns:

the value of the property lookup or null if the property could not be found
getValue
()

The value of the property lookup with transformations (expanded, etc).

Method Detail

getNameback to summary
public String getName()

The name of the property.

Returns:String

the name of the property.

getRawValueback to summary
public String getRawValue()

The value of the property lookup without any transformation (expanded , etc).

Returns:String

the raw value of the property lookup or null if the property could not be found.

getSourceNameback to summary
public String getSourceName()

The org.eclipse.microprofile.config.spi.ConfigSource name that loaded the property lookup.

Returns:String

the ConfigSource name that loaded the property lookup or null if the property could not be found

getSourceOrdinalback to summary
public int getSourceOrdinal()

The org.eclipse.microprofile.config.spi.ConfigSource ordinal that loaded the property lookup.

Returns:int

the ConfigSource ordinal that loaded the property lookup or 0 if the property could not be found

getValueback to summary
public String getValue()

The value of the property lookup with transformations (expanded, etc).

Returns:String

the value of the property lookup or null if the property could not be found