Package software.amazon.smithy.model.traits

Class BoxTrait

java.lang.Object

software.amazon.smithy.model.traits.AnnotationTrait

software.amazon.smithy.model.traits.BoxTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait

@Deprecated
public final class BoxTrait
extends AnnotationTrait

Deprecated.

Use NullableIndex instead.

Indicates that a shape is boxed, meaning a value may or may not be present.

This trait is only used in Smithy IDL 1.0 models and is not allowed in 2.0 models.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BoxTrait.Provider	Deprecated.

Field Summary

Fields

Modifier and Type	Field	Description
static final ShapeId	ID	Deprecated.

Constructor Summary

Constructors

Constructor	Description
BoxTrait()	Deprecated.
BoxTrait(ObjectNode node)	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	isSynthetic()	Deprecated. Checks if this trait is persisted with the shape, or if it is a synthetic, or transient trait, only meant to temporarily aid in some kind of in-memory model transformation.

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

equals, getSourceLocation, hashCode, toNode, toShapeId

Methods inherited from class java.lang.Object

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

Field Details

ID

public static final ShapeId ID

Deprecated.

Constructor Details

BoxTrait

public BoxTrait(ObjectNode node)

Deprecated.

BoxTrait

public BoxTrait()

Deprecated.

Method Details

isSynthetic

public boolean isSynthetic()

Deprecated.

Description copied from interface: Trait

Checks if this trait is persisted with the shape, or if it is a synthetic, or transient trait, only meant to temporarily aid in some kind of in-memory model transformation.

Because synthetic traits are not persisted with shapes, they also do not need to be defined in Smithy's semantic model before they can be used in the model.

Returns:

Returns true if the trait is not persisted on the shape.