Package software.amazon.smithy.docgen

Record Class DocSettings

java.lang.Object
java.lang.Record
software.amazon.smithy.docgen.DocSettings
Record Components:
service - The shape id of the service to generate documentation for.
format - The format to generate documentation in. The default is markdown.
references - A mapping of external resources to their documentation URIs, used when generating links for the references trait for resources that are not contained within the model.
public record DocSettings(ShapeId service, String format, Map<ShapeId,String> references) extends Record
Settings for documentation generation. These can be set in the smithy-build.json configuration for this plugin.

  • Constructor Details

    • DocSettings

      public DocSettings(ShapeId service, String format, Map<ShapeId,String> references)
      Settings for documentation generation. These can be set in the smithy-build.json configuration for this plugin.
      Parameters:
      service - The shape id of the service to generate documentation for.
      format - The format to generate documentation in. The default is markdown.

  • Method Details

    • fromNode

      public static DocSettings fromNode(ObjectNode pluginSettings)
      Load the settings from an ObjectNode.
      Parameters:
      pluginSettings - the ObjectNode to load settings from.
      Returns:
      loaded settings based on the given node.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • service

      public ShapeId service()
      Returns the value of the service record component.
      Returns:
      the value of the service record component

    • format

      public String format()
      Returns the value of the format record component.
      Returns:
      the value of the format record component

    • references

      public Map<ShapeId,String> references()
      Returns the value of the references record component.
      Returns:
      the value of the references record component