Package software.amazon.smithy.model.traits

Class EnumDefinition

java.lang.Object

software.amazon.smithy.model.traits.EnumDefinition

All Implemented Interfaces:

ToNode, Tagged, ToSmithyBuilder<EnumDefinition>

public final class EnumDefinition
extends Object
implements ToNode, ToSmithyBuilder<EnumDefinition>, Tagged

An enum definition for the enum trait.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EnumDefinition.Builder	Builds a EnumDefinition.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEPRECATED
static final String	DOCUMENTATION
static final String	NAME
static final String	TAGS
static final String	VALUE

Method Summary

Modifier and Type	Method	Description
static EnumDefinition.Builder	builder()
boolean	equals(Object other)
static EnumDefinition	fromNode(Node node)
Optional<String>	getDocumentation()
Optional<String>	getName()
List<String>	getTags()	Gets the tags applied to an object.
String	getValue()
int	hashCode()
boolean	isDeprecated()
EnumDefinition.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
Node	toNode()	Converts a value to a Node.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.smithy.utils.Tagged

hasTag

Field Details

VALUE

public static final String VALUE

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

DOCUMENTATION

public static final String DOCUMENTATION

See Also:

• Constant Field Values

TAGS

public static final String TAGS

See Also:

• Constant Field Values

DEPRECATED

public static final String DEPRECATED

See Also:

• Constant Field Values

Method Details

builder

public static EnumDefinition.Builder builder()

getValue

public String getValue()

getName

public Optional<String> getName()

getDocumentation

public Optional<String> getDocumentation()

isDeprecated

public boolean isDeprecated()

toNode

public Node toNode()

Description copied from interface: ToNode

Converts a value to a Node.

Specified by:

toNode in interface ToNode

Returns:

Returns the creates Node.

fromNode

public static EnumDefinition fromNode(Node node)

getTags

public List<String> getTags()

Description copied from interface: Tagged

Gets the tags applied to an object.

Specified by:

getTags in interface Tagged

Returns:

Returns the tag values.

toBuilder

public EnumDefinition.Builder 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<EnumDefinition>

Returns:

a builder for type T

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object