Package software.amazon.smithy.model.traits

Class DiscriminatedTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.model.traits.DiscriminatedTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait

public final class DiscriminatedTrait
extends AbstractTrait

Indicates that this union is serialized as an internally tagged union.

The value of the trait is the name of the field that identifies the active union member. The value is optional when applying the trait; a bare @discriminated is equivalent to @discriminated("__type"). An explicit null value, which a model loader passes to the provider in the same way as a bare trait, is also equivalent to @discriminated("__type"). This is handled here rather than by extending StringTrait because a string trait requires an explicit value, and a @default on the trait's definition is not applied to traits.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DiscriminatedTrait.Provider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_VALUE	The discriminator field name used when the trait is applied without a value.
static final ShapeId	ID

Constructor Summary

Constructors

Constructor	Description
DiscriminatedTrait()	Creates a trait that uses the default discriminator field name.
DiscriminatedTrait(String value)
DiscriminatedTrait(String value, FromSourceLocation sourceLocation)

Method Summary

Modifier and Type	Method	Description
protected Node	createNode()	The result of toNode is used for hashCodes and equality.
String	getValue()

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

DEFAULT_VALUE

public static final String DEFAULT_VALUE

The discriminator field name used when the trait is applied without a value.

See Also:

• Constant Field Values

Constructor Details

DiscriminatedTrait

public DiscriminatedTrait(String value,
 FromSourceLocation sourceLocation)

DiscriminatedTrait

public DiscriminatedTrait(String value)

DiscriminatedTrait

public DiscriminatedTrait()

Creates a trait that uses the default discriminator field name.

Method Details

getValue

public String getValue()

Returns:

the name of the field that identifies the active union member.

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.