Class IdRefTrait

  • All Implemented Interfaces:
    FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<IdRefTrait>

    public final class IdRefTrait
    extends AbstractTrait
    implements ToSmithyBuilder<IdRefTrait>
    Indicates that a string value must contain a valid shape ID.

    failWhenMissing can be set to true to fail when the shape ID contained in a string shape cannot be found in the result set of the selector property. failWhenMissing defaults to false when not set.

    The selector property is used to query the model for all shapes that match a shape selector. The value contained within the string shape targeted by this trait MUST match one of the shapes returns by the shape selector if failWhenMissing is set to true. selector defaults to "*" when not set.

    • Field Detail

      • ID

        public static final ShapeId ID
    • Method Detail

      • getSelector

        public Selector getSelector()
      • failWhenMissing

        public boolean failWhenMissing()
      • getErrorMessage

        public java.util.Optional<java.lang.String> getErrorMessage()
      • 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.