Package software.amazon.smithy.docgen.sections

Record Class BoundOperationsSection

java.lang.Object
java.lang.Record
software.amazon.smithy.docgen.sections.BoundOperationsSection
Record Components:
context - The context used to generate documentation.
container - The service or resource the operations are bound to.
operations - The operations being listed.
All Implemented Interfaces:
CodeSection
public record BoundOperationsSection(DocGenerationContext context, EntityShape container, List<OperationShape> operations) extends Record implements CodeSection
Contains the documentation for all operations bound to a service or resource.

Service documentation will include all operations transitively bound to the service, while resource documentation will only include operations directly bound to the resource through operations or collectionOperations.

See Also:

  • Constructor Details

    • BoundOperationsSection

      public BoundOperationsSection(DocGenerationContext context, EntityShape container, List<OperationShape> operations)
      Creates an instance of a BoundOperationsSection record class.
      Parameters:
      context - the value for the context record component
      container - the value for the container record component
      operations - the value for the operations 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

    • container

      public EntityShape container()
      Returns the value of the container record component.
      Returns:
      the value of the container record component

    • operations

      public List<OperationShape> operations()
      Returns the value of the operations record component.
      Returns:
      the value of the operations record component