Package software.amazon.smithy.docgen.sections

Record Class ShapeMembersSection

java.lang.Object

java.lang.Record

software.amazon.smithy.docgen.sections.ShapeMembersSection

Record Components:

context - The context used to generate documentation.

shape - The shape whose member documentation is being generated.

members - The members being generated.

listingType - The type of the listing.

All Implemented Interfaces:

CodeSection

public record ShapeMembersSection(DocGenerationContext context, Shape shape, Collection<MemberShape> members, MemberGenerator.MemberListingType listingType)
extends Record
implements CodeSection

Generates a listing of a shape's members.

See Also:

• to modify the documentation for an individual member.

Constructor Summary

Constructors

Constructor	Description
ShapeMembersSection(DocGenerationContext context, Shape shape, Collection<MemberShape> members, MemberGenerator.MemberListingType listingType)	Creates an instance of a ShapeMembersSection record class.

Method Summary

Modifier and Type	Method	Description
DocGenerationContext	context()	Returns the value of the context record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
MemberGenerator.MemberListingType	listingType()	Returns the value of the listingType record component.
Collection<MemberShape>	members()	Returns the value of the members record component.
Shape	shape()	Returns the value of the shape record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.smithy.utils.CodeSection

sectionName

Constructor Details

ShapeMembersSection

public ShapeMembersSection(DocGenerationContext context,
 Shape shape,
 Collection<MemberShape> members,
 MemberGenerator.MemberListingType listingType)

Creates an instance of a ShapeMembersSection record class.

Parameters:

context - the value for the context record component

shape - the value for the shape record component

members - the value for the members record component

listingType - the value for the listingType 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

members

public Collection<MemberShape> members()

Returns the value of the members record component.

Returns:

the value of the members record component

listingType

public MemberGenerator.MemberListingType listingType()

Returns the value of the listingType record component.

Returns:

the value of the listingType record component