Class ExamplesTrait

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

public final class ExamplesTrait extends AbstractTrait implements ToSmithyBuilder<ExamplesTrait>
Defines examples for an operation.
See Also:
  • Field Details

    • ID

      public static final ShapeId ID
  • Method Details

    • getExamples

      public List<ExamplesTrait.Example> getExamples()
      Each example.
    • 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.
    • equals

      public boolean equals(Object other)
      equals in class AbstractTrait
    • hashCode

      public int hashCode()
      hashCode in class AbstractTrait
    • toBuilder

      public ExamplesTrait.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<ExamplesTrait>
      a builder for type T
    • builder

      public static ExamplesTrait.Builder builder()
      Returns a builder used to create an examples trait.