Enum Class 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.
  • Enum Constant Details


      public static final SmithyIdlComponentOrder ALPHA_NUMERIC
      Sort shapes, traits, and metadata alphabetically. Member order, however, is not sorted.

      public static final SmithyIdlComponentOrder SOURCE_LOCATION
      Sort shapes, traits, and metadata by source location, persisting their original placement when parsed.

      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.
      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.)
      name - the name of the enum constant to be returned.
      the enum constant with the specified name
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null