software.amazon.smithy.model.traits

Class EnumTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.model.traits.EnumTrait

All Implemented Interfaces:

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

Direct Known Subclasses:

SyntheticEnumTrait

Deprecated.

@Deprecated
public class EnumTrait
extends AbstractTrait
implements software.amazon.smithy.utils.ToSmithyBuilder<EnumTrait>

Constrains string values to one of the predefined enum constants.

This trait is deprecated, use an EnumShape instead.

There is also the SyntheticEnumTrait, which is a synthetic variant of this trait used exclusively to assist in making EnumShape as backwards compatible as possible.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnumTrait.Builder Deprecated. Builder used to create the enum trait.
static class	EnumTrait.Provider Deprecated.

Field Summary

Fields

Modifier and Type	Field and Description
static ShapeId	ID Deprecated.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EnumTrait(ShapeId id, EnumTrait.Builder builder) Deprecated.

Method Summary

Modifier and Type	Method and Description
static EnumTrait.Builder	builder() Deprecated.
protected Node	createNode() Deprecated. The result of toNode is used for hashCodes and equality.
java.util.List<java.lang.String>	getEnumDefinitionValues() Deprecated. Gets the acceptable enum literal values.
java.util.List<EnumDefinition>	getValues() Deprecated. Gets the enum value to body.
boolean	hasNames() Deprecated. Checks if all of the constants of an enum define a name.
EnumTrait.Builder	toBuilder() Deprecated.

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

flatMapStream, getIdiomaticTraitName, getIdiomaticTraitName, isSynthetic, makeAbsoluteName, makeAbsoluteName

Methods inherited from interface software.amazon.smithy.model.FromSourceLocation

compare

Field Detail

ID

public static final ShapeId ID

Deprecated.

Constructor Detail

EnumTrait

protected EnumTrait(ShapeId id,
                    EnumTrait.Builder builder)

Deprecated.

Method Detail

getValues

public java.util.List<EnumDefinition> getValues()

Deprecated.

Gets the enum value to body.

Returns:

returns the enum constant definitions.

getEnumDefinitionValues

public java.util.List<java.lang.String> getEnumDefinitionValues()

Deprecated.

Gets the acceptable enum literal values.

Returns:

returns the enum constant definitions.

hasNames

public boolean hasNames()

Deprecated.

Checks if all of the constants of an enum define a name.

Note that either all constants must have a name or no constants can have a name.

Returns:

Returns true if all constants define a name.

createNode

protected Node createNode()

Deprecated.

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.

toBuilder

public EnumTrait.Builder toBuilder()

Deprecated.

Specified by:

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

builder

public static EnumTrait.Builder builder()

Deprecated.

Returns:

Returns an enum trait builder.