Package software.amazon.smithy.docgen.sections

Record Class ExamplesSection

java.lang.Object

java.lang.Record

software.amazon.smithy.docgen.sections.ExamplesSection

Record Components:

context - The context used to generate documentation.

operation - The operation whose examples are being documented.

examples - The list of examples that will be documented.

All Implemented Interfaces:

CodeSection

public record ExamplesSection(DocGenerationContext context, OperationShape operation, List<ExamplesTrait.Example> examples)
extends Record
implements CodeSection

Generates the documentation for an operation's examples as defined by the example trait.

This controls all the examples for an operation. To modify a single example, use ExampleSection instead.

See Also:

• ExampleSection
• OperationGenerator

Constructor Summary

Constructors

Constructor	Description
ExamplesSection(DocGenerationContext context, OperationShape operation, List<ExamplesTrait.Example> examples)	Creates an instance of a ExamplesSection 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.
List<ExamplesTrait.Example>	examples()	Returns the value of the examples record component.
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

ExamplesSection

public ExamplesSection(DocGenerationContext context,
 OperationShape operation,
 List<ExamplesTrait.Example> examples)

Creates an instance of a ExamplesSection record class.

Parameters:

context - the value for the context record component

operation - the value for the operation record component

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

operation

public OperationShape operation()

Returns the value of the operation record component.

Returns:

the value of the operation record component

examples

public List<ExamplesTrait.Example> examples()

Returns the value of the examples record component.

Returns:

the value of the examples record component