Package software.amazon.smithy.model.validation

Enum Severity

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Severity>, ToNode
    public enum Severity
extends java.lang.Enum<Severity>
implements ToNode
    Severity level of a validation exception.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean canSuppress()
      Check if the severity level of the error can be suppressed.
      static Severity fromNode​(Node node)
      Creates a severity value from a node.
      static java.util.Optional<Severity> fromString​(java.lang.String text)
      Create a new Severity from a string.
      Node toNode()
      Converts a value to a Node.
      static Severity valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Severity[] 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

      • SUPPRESSED

        public static final Severity SUPPRESSED

      • NOTE

        public static final Severity NOTE

      • WARNING

        public static final Severity WARNING

      • DANGER

        public static final Severity DANGER

      • ERROR

        public static final Severity ERROR

    • Method Detail

      • values

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

      • valueOf

        public static Severity 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

      • canSuppress

        public boolean canSuppress()
        Check if the severity level of the error can be suppressed.
        Returns:
        Returns true if a suppression can silence errors at this severity level.

      • fromString

        public static java.util.Optional<Severity> fromString​(java.lang.String text)
        Create a new Severity from a string.
        Parameters:
        text - Text to convert into a severity level.
        Returns:
        Returns the format in an Optional.

      • fromNode

        public static Severity fromNode​(Node node)
        Creates a severity value from a node.
        Parameters:
        node - Node to parse.
        Returns:
        Returns the parsed Severity.
        Throws:
        ExpectationNotMetException - if the node is invalid.

      • toNode

        public Node toNode()
        Description copied from interface: ToNode
        Converts a value to a Node.
        Specified by:
        toNode in interface ToNode
        Returns:
        Returns the creates Node.