Class BoxTrait

All Implemented Interfaces:
FromSourceLocation, ToNode, ToShapeId, Trait

@Deprecated public final class BoxTrait extends AnnotationTrait
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.

  • Field Details

    • ID

      public static final ShapeId ID
  • Constructor Details

    • BoxTrait

      public BoxTrait(ObjectNode node)
    • BoxTrait

      public BoxTrait()
  • Method Details

    • isSynthetic

      public boolean isSynthetic()
      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 true if the trait is not persisted on the shape.