Package software.amazon.smithy.codegen.core.directed

Class GenerateEnumDirective<C extends CodegenContext<S,?,?>,S>

java.lang.Object

software.amazon.smithy.codegen.core.directed.Directive<S>

software.amazon.smithy.codegen.core.directed.ContextualDirective<C,S>

software.amazon.smithy.codegen.core.directed.ShapeDirective<software.amazon.smithy.model.shapes.Shape,C,S>

software.amazon.smithy.codegen.core.directed.GenerateEnumDirective<C,S>

Type Parameters:

C - CodegenContext type.

S - Codegen settings type.

public final class GenerateEnumDirective<C extends CodegenContext<S,?,?>,S>
extends ShapeDirective<software.amazon.smithy.model.shapes.Shape,C,S>

Directive used to generate an enum shape or enum string shape.

See Also:

• DirectedCodegen.generateEnumShape(software.amazon.smithy.codegen.core.directed.GenerateEnumDirective<C, S>)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GenerateEnumDirective.EnumType	Represents the type of enum to generate.

Method Summary

Modifier and Type	Method	Description
software.amazon.smithy.model.shapes.EnumShape	expectEnumShape()
software.amazon.smithy.model.traits.EnumTrait	getEnumTrait()	Gets the EnumTrait of the shape.
GenerateEnumDirective.EnumType	getEnumType()	Gets the type of enum being generated, whether it's a string shape marked with the enum trait or, in Smithy IDL 2.0, an actual enum shape.

Methods inherited from class software.amazon.smithy.codegen.core.directed.ShapeDirective

shape, symbol

Methods inherited from class software.amazon.smithy.codegen.core.directed.ContextualDirective

context, fileManifest, symbolProvider

Methods inherited from class software.amazon.smithy.codegen.core.directed.Directive

connectedShapes, model, operations, service, settings

Methods inherited from class java.lang.Object

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

Method Details

getEnumType

public GenerateEnumDirective.EnumType getEnumType()

Gets the type of enum being generated, whether it's a string shape marked with the enum trait or, in Smithy IDL 2.0, an actual enum shape.

Note that Smithy IDL 2.0 generators can perform a pre-processing transform to convert eligible string shape enums to proper enums, removing the need to check this property.

Returns:

Gets the type of enum being generated.

See Also:

• getEnumTrait()

getEnumTrait

public software.amazon.smithy.model.traits.EnumTrait getEnumTrait()

Gets the EnumTrait of the shape.

Returns:

Returns the enum trait.

expectEnumShape

public software.amazon.smithy.model.shapes.EnumShape expectEnumShape()