Package software.amazon.smithy.model.traits

Class DeprecatedTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.model.traits.DeprecatedTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, software.amazon.smithy.utils.ToSmithyBuilder<DeprecatedTrait>

public final class DeprecatedTrait
extends AbstractTrait
implements software.amazon.smithy.utils.ToSmithyBuilder<DeprecatedTrait>

Marks a shape as deprecated.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DeprecatedTrait.Builder	Builder used to create a DeprecatedTrait.
static final class	DeprecatedTrait.Provider

Field Summary

Fields

Modifier and Type	Field	Description
static final ShapeId	ID

Method Summary

Modifier and Type	Method	Description
static DeprecatedTrait.Builder	builder()
protected Node	createNode()	The result of toNode is used for hashCodes and equality.
String	getDeprecatedDescription(ShapeType shapeType)
Optional<String>	getMessage()	Gets the deprecation message value.
Optional<String>	getSince()	Gets the deprecated since value.
DeprecatedTrait.Builder	toBuilder()

Methods inherited from class software.amazon.smithy.model.traits.AbstractTrait

equals, getSourceLocation, hashCode, setNodeCache, toNode, toShapeId, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.smithy.model.traits.Trait

isSynthetic

Field Details

ID

public static final ShapeId ID

Method Details

getSince

public Optional<String> getSince()

Gets the deprecated since value.

Returns:

returns the optional deprecated since value.

getMessage

public Optional<String> getMessage()

Gets the deprecation message value.

Returns:

returns the optional deprecation message value.

getDeprecatedDescription

public String getDeprecatedDescription(ShapeType shapeType)

createNode

protected Node createNode()

Description copied from class: AbstractTrait

The result of toNode is used for hashCodes and equality. Subclasses must implement createNode to turn the trait into a Node. This is then cached for subsequent retrievals.

Specified by:

createNode in class AbstractTrait

Returns:

Returns the trait as a node.

toBuilder

public DeprecatedTrait.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.smithy.utils.ToSmithyBuilder<DeprecatedTrait>

builder

public static DeprecatedTrait.Builder builder()

Returns:

Returns a builder used to create a deprecated trait.