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
Modifier and TypeClassDescriptionstatic final class
Builder used to create a DeprecatedTrait.static final class
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DeprecatedTrait.Builder
builder()
protected Node
The result of toNode is used for hashCodes and equality.Gets the deprecation message value.getSince()
Gets the deprecated since value.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
-
-
Method Details
-
getSince
Gets the deprecated since value.- Returns:
- returns the optional deprecated since value.
-
getMessage
Gets the deprecation message value.- Returns:
- returns the optional deprecation message value.
-
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 classAbstractTrait
- Returns:
- Returns the trait as a node.
-
toBuilder
- Specified by:
toBuilder
in interfacesoftware.amazon.smithy.utils.ToSmithyBuilder<DeprecatedTrait>
-
builder
- Returns:
- Returns a builder used to create a deprecated trait.
-