Package uk.org.webcompere.modelassert.json.condition.tree

Enum Class TreeRule

java.lang.Object

java.lang.Enum<TreeRule>

uk.org.webcompere.modelassert.json.condition.tree.TreeRule

All Implemented Interfaces:

Serializable, Comparable<TreeRule>, Constable

public enum TreeRule
extends Enum<TreeRule>

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
ARRAY_CONTAINS	Allow the array to contain the elements, rather than match perfectly can be combined with allowing any order
CONDITION	Apply a specific condition instead of the tree comparison
IGNORE_ARRAY_ORDER	Allow the array to be in any order
IGNORE_KEY_ORDER	Ignore the order of keys in an object
OBJECT_CONTAINS	Skip over fields that are missing in the other object - implies keys in any order
REQUIRE_KEY_ORDER	When the key order is important

Method Summary

Modifier and Type	Method	Description
static TreeRule	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TreeRule[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IGNORE_KEY_ORDER

public static final TreeRule IGNORE_KEY_ORDER

Ignore the order of keys in an object

REQUIRE_KEY_ORDER

public static final TreeRule REQUIRE_KEY_ORDER

When the key order is important

CONDITION

public static final TreeRule CONDITION

Apply a specific condition instead of the tree comparison

IGNORE_ARRAY_ORDER

public static final TreeRule IGNORE_ARRAY_ORDER

Allow the array to be in any order

ARRAY_CONTAINS

public static final TreeRule ARRAY_CONTAINS

Allow the array to contain the elements, rather than match perfectly can be combined with allowing any order

OBJECT_CONTAINS

public static final TreeRule OBJECT_CONTAINS

Skip over fields that are missing in the other object - implies keys in any order

Method Details

values

public static TreeRule[] 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 TreeRule 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