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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Deprecation.Level Define the deprecation level.

Constructor Summary

Constructors

Constructor and Description
Deprecation()

Method Summary

Modifier and Type	Method and Description
Deprecation.Level	getLevel() Define the Deprecation.Level of deprecation.
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.
String	getShortReason() A single-line, single-sentence reason why the related property is deprecated, if any.
void	setLevel(Deprecation.Level level)
void	setReason(String reason)
void	setReplacement(String replacement)
void	setShortReason(String shortReason)
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

getLevel

public Deprecation.Level getLevel()

Define the Deprecation.Level of deprecation.

Returns:

the deprecation level

setLevel

public void setLevel(Deprecation.Level level)

getReason

public String getReason()

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

Returns:

the deprecation reason

See Also:

getShortReason()

setReason

public void setReason(String reason)

getShortReason

public String getShortReason()

A single-line, single-sentence reason why the related property is deprecated, if any.

Returns:

the short deprecation reason

See Also:

getReason()

setShortReason

public void setShortReason(String shortReason)

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