Package software.amazon.smithy.model.validation

Enum NodeValidationVisitor.Feature

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      RANGE_TRAIT_ZERO_VALUE_WARNING
      Emit a warning when a range trait is incompatible with a default value of 0.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static NodeValidationVisitor.Feature valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static NodeValidationVisitor.Feature[] 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

      • RANGE_TRAIT_ZERO_VALUE_WARNING

        public static final NodeValidationVisitor.Feature RANGE_TRAIT_ZERO_VALUE_WARNING
        Emit a warning when a range trait is incompatible with a default value of 0.

        This was a common pattern in Smithy 1.0 and earlier. It implies that the value is effectively required. However, chaning the type of the value by un-boxing it or adjusting the range trait would be a lossy tranformation when migrating a model from 1.0 to 2.0.

    • Method Detail

      • values

        public static NodeValidationVisitor.Feature[] 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 (NodeValidationVisitor.Feature c : NodeValidationVisitor.Feature.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static NodeValidationVisitor.Feature 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