Package software.amazon.smithy.model.traits

Class IdRefTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.model.traits.IdRefTrait

All Implemented Interfaces:

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

public final class IdRefTrait
extends AbstractTrait
implements software.amazon.smithy.utils.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.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ShapeId	ID

Method Summary

Modifier and Type	Method	Description
static IdRefTrait.Builder	builder()
protected Node	createNode()	The result of toNode is used for hashCodes and equality.
boolean	failWhenMissing()
Optional<String>	getErrorMessage()
Selector	getSelector()
IdRefTrait.Builder	toBuilder()

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

Method Details

getSelector

public Selector getSelector()

failWhenMissing

public boolean failWhenMissing()

getErrorMessage

public Optional<String> getErrorMessage()

toBuilder

public IdRefTrait.Builder toBuilder()

Specified by:

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

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.

builder

public static IdRefTrait.Builder builder()