Package software.amazon.smithy.docgen.sections

Record Class BoundResourcesSection

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

Service documentation will include all resources transitively bound to the service, while resource documentation will only include sub-resources directly bound to the resource.

See Also:

  • Constructor Details

    • BoundResourcesSection

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

    • resources

      public List<ResourceShape> resources()
      Returns the value of the resources record component.
      Returns:
      the value of the resources record component