org.springframework.boot.configurationmetadata

Class Deprecation

java.lang.Object

org.springframework.boot.configurationmetadata.Deprecation

All Implemented Interfaces:

Serializable

public class Deprecation
extends Object
implements Serializable

Indicate that a property is deprecated. Provide additional information about the deprecation.

Since:

1.3.0

Author:

Stephane Nicoll

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Deprecation()

Method Summary

Modifier and Type	Method and Description
String	getReason() A reason why the related property is deprecated, if any.
String	getReplacement() The full name of the property that replaces the related deprecated property, if any.
void	setReason(String reason)
void	setReplacement(String replacement)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Deprecation

public Deprecation()

Method Detail

getReason

public String getReason()

A reason why the related property is deprecated, if any. Can be multi-lines.

Returns:

the deprecation reason

setReason

public void setReason(String reason)

getReplacement

public String getReplacement()

The full name of the property that replaces the related deprecated property, if any.

Returns:

the replacement property name

setReplacement

public void setReplacement(String replacement)

toString

public String toString()

Overrides:

toString in class Object