Package software.amazon.smithy.model.traits

Class UnstableTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.model.traits.UnstableTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<UnstableTrait>

public final class UnstableTrait
extends AbstractTrait
implements ToSmithyBuilder<UnstableTrait>

Indicates that a shape is unstable and could change in the future.

An optional feature id associates the shape with a preview feature defined by the enclosing service's unstableFeatures trait.

See Also:

• UnstableFeaturesTrait

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UnstableTrait.Builder
static final class	UnstableTrait.Provider

Field Summary

Fields

Modifier and Type	Field	Description
static final ShapeId	ID

Constructor Summary

Constructors

Constructor	Description
UnstableTrait()
UnstableTrait(ObjectNode node)

Method Summary

Modifier and Type	Method	Description
static UnstableTrait.Builder	builder()
protected Node	createNode()	The result of toNode is used for hashCodes and equality.
Optional<String>	getFeatureId()	Gets the id of the unstable feature this shape belongs to, if any.
UnstableTrait.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.

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

equals, getSourceLocation, hashCode, setNodeCache, 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

Constructor Details

UnstableTrait

public UnstableTrait(ObjectNode node)

UnstableTrait

public UnstableTrait()

Method Details

getFeatureId

public Optional<String> getFeatureId()

Gets the id of the unstable feature this shape belongs to, if any.

Returns:

Returns the optional feature id.

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 UnstableTrait.Builder toBuilder()

Description copied from interface: ToSmithyBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToSmithyBuilder<UnstableTrait>

Returns:

a builder for type T

builder

public static UnstableTrait.Builder builder()