Package software.amazon.smithy.docgen.sections

Record Class BoundOperationSection

java.lang.Object

java.lang.Record

software.amazon.smithy.docgen.sections.BoundOperationSection

Record Components:

context - The context used to generate documentation.

container - The service or resource the operation is bound to.

operation - The operation being listed.

All Implemented Interfaces:

CodeSection

public record BoundOperationSection(DocGenerationContext context, EntityShape container, OperationShape operation)
extends Record
implements CodeSection

Contains the documentation for individual 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:

• For the section containing all operations bound to the service or resource.
• For operations bound to a resource's lifecycle operations.
• for information about other sections present on the service's documentation page.
• for information about other sections present on the documentation pages for resrouces.

Constructor Summary

Constructors

Constructor	Description
BoundOperationSection(DocGenerationContext context, EntityShape container, OperationShape operation)	Creates an instance of a BoundOperationSection record class.

Method Summary

Modifier and Type	Method	Description
EntityShape	container()	Returns the value of the container record component.
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.
OperationShape	operation()	Returns the value of the operation 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

BoundOperationSection

public BoundOperationSection(DocGenerationContext context,
 EntityShape container,
 OperationShape operation)

Creates an instance of a BoundOperationSection record class.

Parameters:

context - the value for the context record component

container - the value for the container record component

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

operation

public OperationShape operation()

Returns the value of the operation record component.

Returns:

the value of the operation record component