Package software.amazon.smithy.waiters

Enum Class PathComparator

java.lang.Object

java.lang.Enum<PathComparator>

software.amazon.smithy.waiters.PathComparator

All Implemented Interfaces:

Serializable, Comparable<PathComparator>, Constable, ToNode

public enum PathComparator
extends Enum<PathComparator>
implements ToNode

Defines a comparison to perform in a PathMatcher.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

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

Modifier and Type	Method	Description
static PathComparator	fromNode(Node node)	Creates a PathComparator from a Node.
Node	toNode()	Converts a value to a Node.
String	toString()
static PathComparator	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PathComparator[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static PathComparator[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

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

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

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 String toString()

Overrides:

toString in class 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.