Package software.amazon.smithy.model.shapes

Enum SmithyIdlComponentOrder

    • 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

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static SmithyIdlComponentOrder valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SmithyIdlComponentOrder[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • 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 Detail

      • values

        public static SmithyIdlComponentOrder[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (SmithyIdlComponentOrder c : SmithyIdlComponentOrder.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SmithyIdlComponentOrder valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null