Class ExternalDocumentationTrait

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

public final class ExternalDocumentationTrait extends AbstractTrait implements ToSmithyBuilder<ExternalDocumentationTrait>
Provides named links to external documentation.
  • Field Details

    • ID

      public static final ShapeId ID
  • Constructor Details

  • Method Details

    • getUrls

      public Map<String,String> getUrls()
      Gets the external documentation names and links.
      returns the external documentation mapping.
    • 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

      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<ExternalDocumentationTrait>
      a builder for type T
    • builder

      public static ExternalDocumentationTrait.Builder builder()
      Returns an external documentation trait builder.