Package software.amazon.smithy.model.traits

Class EnumValueTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.model.traits.EnumValueTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<EnumValueTrait>

public final class EnumValueTrait
extends AbstractTrait
implements ToSmithyBuilder<EnumValueTrait>

Sets the value for an enum member.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EnumValueTrait.Builder
static class	EnumValueTrait.Provider

Field Summary

Fields

Modifier and Type	Field	Description
static ShapeId	ID

Method Summary

Modifier and Type	Method	Description
static EnumValueTrait.Builder	builder()
protected Node	createNode()	The result of toNode is used for hashCodes and equality.
int	expectIntValue()	Gets the int value.
java.lang.String	expectStringValue()	Gets the string value.
java.util.Optional<java.lang.Integer>	getIntValue()	Gets the int value if an int value was set.
java.util.Optional<java.lang.String>	getStringValue()	Gets the string value if a string value was set.
SmithyBuilder<EnumValueTrait>	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.

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 Detail

ID

public static final ShapeId ID

Method Detail

getStringValue

public java.util.Optional<java.lang.String> getStringValue()

Gets the string value if a string value was set.

Returns:

Optionally returns the string value.

expectStringValue

public java.lang.String expectStringValue()

Gets the string value.

Returns:

Returns the string value.

Throws:

ExpectationNotMetException - if the string value was not set.

getIntValue

public java.util.Optional<java.lang.Integer> getIntValue()

Gets the int value if an int value was set.

Returns:

Returns the set int value.

expectIntValue

public int expectIntValue()

Gets the int value.

Returns:

Returns the int value.

Throws:

ExpectationNotMetException - if the int value was not set.

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.

toBuilder

public SmithyBuilder<EnumValueTrait> toBuilder()

Description copied from interface: ToSmithyBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToSmithyBuilder<EnumValueTrait>

Returns:

a builder for type T

builder

public static EnumValueTrait.Builder builder()