Package software.amazon.smithy.model.shapes

Enum Class SmithyIdlComponentOrder

java.lang.Object

java.lang.Enum<SmithyIdlComponentOrder>

software.amazon.smithy.model.shapes.SmithyIdlComponentOrder

All Implemented Interfaces:

Serializable, Comparable<SmithyIdlComponentOrder>, Constable

public enum SmithyIdlComponentOrder
extends Enum<SmithyIdlComponentOrder>

Defines how shapes, traits, and metadata are sorted when serializing a model with SmithyIdlModelSerializer.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALPHA_NUMERIC	Sort shapes, traits, and metadata alphabetically.
PREFERRED	Reorganizes shapes based on a preferred ordering of shapes, and alphanumeric traits and metadata.
SOURCE_LOCATION	Sort shapes, traits, and metadata by source location, persisting their original placement when parsed.

Method Summary

Modifier and Type	Method	Description
static SmithyIdlComponentOrder	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SmithyIdlComponentOrder[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALPHA_NUMERIC

public static final SmithyIdlComponentOrder ALPHA_NUMERIC

Sort shapes, traits, and metadata alphabetically. Member order, however, is not sorted.

SOURCE_LOCATION

public static final SmithyIdlComponentOrder SOURCE_LOCATION

Sort shapes, traits, and metadata by source location, persisting their original placement when parsed.

PREFERRED

public static final SmithyIdlComponentOrder PREFERRED

Reorganizes shapes based on a preferred ordering of shapes, and alphanumeric traits and metadata.

Shapes are ordered as follows:

• Trait definitions
• Services
• Resources
• Operations
• Structures
• Unions
• Lists
• Maps
• Finally, alphabetically by shape type.

Method Details

values

public static SmithyIdlComponentOrder[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SmithyIdlComponentOrder valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null