Package software.amazon.smithy.docgen.sections

Record Class MemberSection

java.lang.Object
java.lang.Record
software.amazon.smithy.docgen.sections.MemberSection
Record Components:
context - The context used to generate documentation.
member - The member whose documentation is being generated.
All Implemented Interfaces:
CodeSection
public record MemberSection(DocGenerationContext context, MemberShape member) extends Record implements CodeSection
Enables modifying or overwriting the documentation for a member.
See Also:

  • Constructor Details

    • MemberSection

      public MemberSection(DocGenerationContext context, MemberShape member)
      Creates an instance of a MemberSection record class.
      Parameters:
      context - the value for the context record component
      member - the value for the member 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

    • member

      public MemberShape member()
      Returns the value of the member record component.
      Returns:
      the value of the member record component