Enum Class Rule

java.lang.Object

java.lang.Enum<Rule>

ca.marcusdunn.jsonlens.testkit.Rule

All Implemented Interfaces:

Serializable, Comparable<Rule>, Constable

public enum Rule
extends Enum<Rule>

A rule of the JsonModel contract that ModelVerifier checks.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPARE_NUMBERS	JsonModel.compareNumbers(ca.marcusdunn.jsonlens.model.JsonNumber, ca.marcusdunn.jsonlens.model.JsonNumber) has the sign of the comparison of the exact values.
ELEMENTS	JsonModel.element(Object, int) gives an element for each index below the length, and none outside the array.
EQUAL	JsonModel.equal(Object, Object) gives the result of the default method.
EQUAL_NODES	Two reads of the same value give equal nodes with equal hash codes.
HAS_DUPLICATE	JsonModel.hasDuplicate(Object, ca.marcusdunn.jsonlens.model.JsonString) tells if the cursor gives two or more members with the name.
MEMBER	JsonModel.member(Object, ca.marcusdunn.jsonlens.model.JsonString) gives the value of the first member of the cursor with the name.
MEMBER_COUNT	JsonModel.memberCount(Object) gives the number of members of the cursor.
MEMBER_CURSOR	The cursor gives the same members in the same order each time, and stays at the end.
MEMBERS	JsonModel.members(Object) gives the members of the cursor, in order.
NO_EXCEPTIONS	No method throws an exception.
NO_NULLS	No method returns null.
NUMBER_VALUE	JsonModel.numberValue(Object) gives the same exact value each time.
STRING_VALUE	JsonModel.stringValue(Object) gives the same scalar values each time.

Method Summary

Modifier and Type	Method	Description
String	text()	Returns the rule as a sentence.
static Rule	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Rule[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NO_EXCEPTIONS

public static final Rule NO_EXCEPTIONS

No method throws an exception.

NO_NULLS

public static final Rule NO_NULLS

No method returns null.

ELEMENTS

public static final Rule ELEMENTS

JsonModel.element(Object, int) gives an element for each index below the length, and none outside the array.

MEMBER_CURSOR

public static final Rule MEMBER_CURSOR

The cursor gives the same members in the same order each time, and stays at the end.

MEMBER_COUNT

public static final Rule MEMBER_COUNT

JsonModel.memberCount(Object) gives the number of members of the cursor.

MEMBER

public static final Rule MEMBER

JsonModel.member(Object, ca.marcusdunn.jsonlens.model.JsonString) gives the value of the first member of the cursor with the name.

MEMBERS

public static final Rule MEMBERS

JsonModel.members(Object) gives the members of the cursor, in order.

HAS_DUPLICATE

public static final Rule HAS_DUPLICATE

JsonModel.hasDuplicate(Object, ca.marcusdunn.jsonlens.model.JsonString) tells if the cursor gives two or more members with the name.

EQUAL_NODES

public static final Rule EQUAL_NODES

Two reads of the same value give equal nodes with equal hash codes.

STRING_VALUE

public static final Rule STRING_VALUE

JsonModel.stringValue(Object) gives the same scalar values each time.

NUMBER_VALUE

public static final Rule NUMBER_VALUE

JsonModel.numberValue(Object) gives the same exact value each time.

COMPARE_NUMBERS

public static final Rule COMPARE_NUMBERS

JsonModel.compareNumbers(ca.marcusdunn.jsonlens.model.JsonNumber, ca.marcusdunn.jsonlens.model.JsonNumber) has the sign of the comparison of the exact values.

EQUAL

public static final Rule EQUAL

JsonModel.equal(Object, Object) gives the result of the default method.

Method Details

values

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

text

public String text()

Returns the rule as a sentence.

Returns:

the text of the rule