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 java.lang.Object
implements ToNode, ToSmithyBuilder<EnumDefinition>, Tagged

An enum definition for the enum trait.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEPRECATED
static java.lang.String	DOCUMENTATION
static java.lang.String	NAME
static java.lang.String	TAGS
static java.lang.String	VALUE

Method Summary

Modifier and Type	Method and Description
static EnumDefinition.Builder	builder()
boolean	equals(java.lang.Object other)
static EnumDefinition	fromNode(Node node)
java.util.Optional<java.lang.String>	getDocumentation()
java.util.Optional<java.lang.String>	getName()
java.util.List<java.lang.String>	getTags() Gets the tags applied to an object.
java.lang.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 Detail

VALUE

public static final java.lang.String VALUE

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

DOCUMENTATION

public static final java.lang.String DOCUMENTATION

See Also:

Constant Field Values

TAGS

public static final java.lang.String TAGS

See Also:

Constant Field Values

DEPRECATED

public static final java.lang.String DEPRECATED

See Also:

Constant Field Values

Method Detail

builder

public static EnumDefinition.Builder builder()

getValue

public java.lang.String getValue()

getName

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

getDocumentation

public java.util.Optional<java.lang.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 java.util.List<java.lang.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(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object