Class ConfigurationProperty

java.lang.Object

org.springframework.boot.context.properties.source.ConfigurationProperty

All Implemented Interfaces:

Comparable<ConfigurationProperty>, OriginProvider

public final class ConfigurationProperty
extends Object
implements OriginProvider, Comparable<ConfigurationProperty>

A single configuration property obtained from a ConfigurationPropertySource consisting of a name, value and optional origin.

Since:

2.0.0

Author:

Phillip Webb, Madhura Bhave

Constructor Summary

Constructors

Constructor	Description
ConfigurationProperty(ConfigurationPropertyName name, Object value, @Nullable Origin origin)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ConfigurationProperty other)
boolean	equals(Object obj)
ConfigurationPropertyName	getName()	Return the name of the configuration property.
@Nullable Origin	getOrigin()	Return the source origin or null if the origin is not known.
@Nullable ConfigurationPropertySource	getSource()	Return the ConfigurationPropertySource that provided the property or null if the source is unknown.
Object	getValue()	Return the value of the configuration property.
int	hashCode()
String	toString()

Methods inherited from class Object

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

Constructor Details

ConfigurationProperty

public ConfigurationProperty(ConfigurationPropertyName name,
 Object value,
 @Nullable Origin origin)

Method Details

getSource

public @Nullable ConfigurationPropertySource getSource()

Return the ConfigurationPropertySource that provided the property or null if the source is unknown.

Returns:

the configuration property source

Since:

2.6.0

getName

public ConfigurationPropertyName getName()

Return the name of the configuration property.

Returns:

the configuration property name

getValue

public Object getValue()

Return the value of the configuration property.

Returns:

the configuration property value

getOrigin

public @Nullable Origin getOrigin()

Description copied from interface: OriginProvider

Return the source origin or null if the origin is not known.

Specified by:

getOrigin in interface OriginProvider

Returns:

the origin or null

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(ConfigurationProperty other)

Specified by:

compareTo in interface Comparable<ConfigurationProperty>