Package software.amazon.smithy.waiters

Enum PathComparator

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PathComparator>, ToNode
    public enum PathComparator
extends java.lang.Enum<PathComparator>
implements ToNode
    Defines a comparison to perform in a PathMatcher.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALL_STRING_EQUALS
      Matches if all values in the list matches the expected string.
      ANY_STRING_EQUALS
      Matches if any value in the list matches the expected string.
      BOOLEAN_EQUALS
      Matches if the return value is a boolean that is equal to the string literal 'true' or 'false'.
      STRING_EQUALS
      Matches if the return value is a string that is equal to the expected string.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static PathComparator fromNode​(Node node)
      Creates a PathComparator from a Node.
      Node toNode()
      Converts a value to a Node.
      java.lang.String toString()  
      static PathComparator valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PathComparator[] 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, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • ALL_STRING_EQUALS

        public static final PathComparator ALL_STRING_EQUALS
        Matches if all values in the list matches the expected string.

      • ANY_STRING_EQUALS

        public static final PathComparator ANY_STRING_EQUALS
        Matches if any value in the list matches the expected string.

      • STRING_EQUALS

        public static final PathComparator STRING_EQUALS
        Matches if the return value is a string that is equal to the expected string.

      • BOOLEAN_EQUALS

        public static final PathComparator BOOLEAN_EQUALS
        Matches if the return value is a boolean that is equal to the string literal 'true' or 'false'.

    • Method Detail

      • values

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

      • valueOf

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

      • fromNode

        public static PathComparator fromNode​(Node node)
        Creates a PathComparator from a Node.
        Parameters:
        node - Node to create the PathComparator from.
        Returns:
        Returns the created PathComparator.
        Throws:
        ExpectationNotMetException - if the given node is invalid.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<PathComparator>

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