Package software.amazon.smithy.docgen.sections

Record Class ProtocolsSection

java.lang.Object
java.lang.Record
software.amazon.smithy.docgen.sections.ProtocolsSection
Record Components:
context - The context used to generate documentation.
shape - The shape to add protocol information to.
All Implemented Interfaces:
CodeSection
public record ProtocolsSection(DocGenerationContext context, Shape shape) extends Record implements CodeSection
A section that contains all protocol-specific information for the given shape for all protocols.

Each individual protocol has its own ProtocolSection. If the service has more than one protocol, these sections will be in tabs.

See Also:

  • Constructor Details

    • ProtocolsSection

      public ProtocolsSection(DocGenerationContext context, Shape shape)
      Creates an instance of a ProtocolsSection record class.
      Parameters:
      context - the value for the context record component
      shape - the value for the shape record component

  • Method Details

    • 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.

    • context

      public DocGenerationContext context()
      Returns the value of the context record component.
      Returns:
      the value of the context record component

    • shape

      public Shape shape()
      Returns the value of the shape record component.
      Returns:
      the value of the shape record component