Class DeprecatedTrait

All Implemented Interfaces:
FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<DeprecatedTrait>

public final class DeprecatedTrait extends AbstractTrait implements ToSmithyBuilder<DeprecatedTrait>
Marks a shape as deprecated.
  • Field Details

    • ID

      public static final ShapeId ID
  • Method Details

    • getSince

      public Optional<String> getSince()
      Gets the deprecated since value.
      returns the optional deprecated since value.
    • getMessage

      public Optional<String> getMessage()
      Gets the deprecation message value.
      returns the optional deprecation message value.
    • 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 the trait as a node.
    • toBuilder

      public DeprecatedTrait.Builder toBuilder()
      Description copied from interface: ToSmithyBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToSmithyBuilder<DeprecatedTrait>
      a builder for type T
    • builder

      public static DeprecatedTrait.Builder builder()
      Returns a builder used to create a deprecated trait.