io.smallrye.config

Class ConfigValue

java.lang.Object

io.smallrye.config.ConfigValue

All Implemented Interfaces:

org.eclipse.microprofile.config.ConfigValue

@Experimental(value="Extension to the original ConfigSource to allow retrieval of additional metadata on config lookup")
public class ConfigValue
extends Object
implements org.eclipse.microprofile.config.ConfigValue

The ConfigValue is a metadata object that holds additional information after the lookup of a configuration.

Right now, it is able to hold information like the configuration name, value, the Config Source from where the configuration was loaded, the ordinal of the Config Source and a line number from where the configuration was read if exists.

This is used together with ConfigValueConfigSource and ConfigSourceInterceptor to expose the Configuration lookup metadata.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigValue.ConfigValueBuilder

Method Summary

Modifier and Type	Method and Description
static ConfigValue.ConfigValueBuilder	builder()
boolean	equals(Object o)
String	getConfigSourceName()
int	getConfigSourceOrdinal()
int	getLineNumber()
String	getLocation()
String	getName()
String	getRawValue()
String	getSourceName()
int	getSourceOrdinal()
String	getValue()
int	hashCode()
ConfigValue	withConfigSourceName(String configSourceName)
ConfigValue	withConfigSourceOrdinal(int configSourceOrdinal)
ConfigValue	withLineNumber(int lineNumber)
ConfigValue	withName(String name)
ConfigValue	withValue(String value)

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Specified by:

getName in interface org.eclipse.microprofile.config.ConfigValue

getValue

public String getValue()

Specified by:

getValue in interface org.eclipse.microprofile.config.ConfigValue

getRawValue

public String getRawValue()

Specified by:

getRawValue in interface org.eclipse.microprofile.config.ConfigValue

getSourceName

public String getSourceName()

Specified by:

getSourceName in interface org.eclipse.microprofile.config.ConfigValue

getSourceOrdinal

public int getSourceOrdinal()

Specified by:

getSourceOrdinal in interface org.eclipse.microprofile.config.ConfigValue

getConfigSourceName

public String getConfigSourceName()

getConfigSourceOrdinal

public int getConfigSourceOrdinal()

getLineNumber

public int getLineNumber()

getLocation

public String getLocation()

withName

public ConfigValue withName(String name)

withValue

public ConfigValue withValue(String value)

withConfigSourceName

public ConfigValue withConfigSourceName(String configSourceName)

withConfigSourceOrdinal

public ConfigValue withConfigSourceOrdinal(int configSourceOrdinal)

withLineNumber

public ConfigValue withLineNumber(int lineNumber)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static ConfigValue.ConfigValueBuilder builder()