Class InvalidConfigurationPropertyValueException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.boot.context.properties.source.InvalidConfigurationPropertyValueException

All Implemented Interfaces:

Serializable

public class InvalidConfigurationPropertyValueException
extends RuntimeException

Exception thrown when a configuration property value is invalid.

Since:

2.0.0

Author:

Stephane Nicoll

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
InvalidConfigurationPropertyValueException(String name, @Nullable Object value, @Nullable String reason)	Creates a new instance for the specified property name and value, including a reason why the value is invalid.

Method Summary

Modifier and Type	Method	Description
String	getName()	Return the name of the property.
@Nullable String	getReason()	Return the reason why the value is invalid.
@Nullable Object	getValue()	Return the invalid value, can be null.

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

InvalidConfigurationPropertyValueException

public InvalidConfigurationPropertyValueException(String name,
 @Nullable Object value,
 @Nullable String reason)

Creates a new instance for the specified property name and value, including a reason why the value is invalid.

Parameters:

name - the name of the property in canonical format

value - the value of the property, can be null

reason - a human-readable text that describes why the reason is invalid. Starts with an upper-case and ends with a dot. Several sentences and carriage returns are allowed.

Method Details

getName

public String getName()

Return the name of the property.

Returns:

the property name

getValue

public @Nullable Object getValue()

Return the invalid value, can be null.

Returns:

the invalid value

getReason

public @Nullable String getReason()

Return the reason why the value is invalid.

Returns:

the reason