Package software.amazon.smithy.model.traits

Class ExamplesTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.model.traits.ExamplesTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, software.amazon.smithy.utils.ToSmithyBuilder<ExamplesTrait>

public final class ExamplesTrait
extends AbstractTrait
implements software.amazon.smithy.utils.ToSmithyBuilder<ExamplesTrait>

Defines examples for an operation.

See Also:

• ExamplesTraitValidator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ExamplesTrait.Builder	Builds and examples trait.
static final class	ExamplesTrait.ErrorExample
static final class	ExamplesTrait.Example	A specific example.
static final class	ExamplesTrait.Provider

Field Summary

Fields

Modifier and Type	Field	Description
static final ShapeId	ID

Method Summary

Modifier and Type	Method	Description
static ExamplesTrait.Builder	builder()
protected Node	createNode()	The result of toNode is used for hashCodes and equality.
List<ExamplesTrait.Example>	getExamples()
ExamplesTrait.Builder	toBuilder()

Methods inherited from class software.amazon.smithy.model.traits.AbstractTrait

equals, getSourceLocation, hashCode, toNode, toShapeId, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.smithy.model.traits.Trait

isSynthetic

Field Details

ID

public static final ShapeId ID

Method Details

getExamples

public List<ExamplesTrait.Example> getExamples()

Returns:

Each example.

createNode

protected Node createNode()

Description copied from class: AbstractTrait

The result of toNode is used for hashCodes and equality. Subclasses must implement createNode to turn the trait into a Node. This is then cached for subsequent retrievals.

Specified by:

createNode in class AbstractTrait

Returns:

Returns the trait as a node.

toBuilder

public ExamplesTrait.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.smithy.utils.ToSmithyBuilder<ExamplesTrait>

builder

public static ExamplesTrait.Builder builder()

Returns:

Returns a builder used to create an examples trait.