org.forgerock.cuppa.model

Enum TestBlockType

java.lang.Object

java.lang.Enum<TestBlockType>

org.forgerock.cuppa.model.TestBlockType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TestBlockType>

public enum TestBlockType
extends java.lang.Enum<TestBlockType>

Models the type of a test block.

See Also:

TestBlock

Enum Constant Summary

Enum Constants

Enum Constant and Description
DESCRIBE A 'describe' test block.
ROOT Root test block, which contains all other test blocks and tests.
WHEN A 'when' test block.

Method Summary

Modifier and Type	Method and Description
static TestBlockType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TestBlockType[]	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

ROOT

public static final TestBlockType ROOT

Root test block, which contains all other test blocks and tests. Root test blocks have no description.

DESCRIBE

public static final TestBlockType DESCRIBE

A 'describe' test block. These are typically created by calling Cuppa.describe(String, TestBlockFunction).

WHEN

public static final TestBlockType WHEN

A 'when' test block. These are typically created by calling Cuppa.when(String, TestBlockFunction).

Method Detail

values

public static TestBlockType[] 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 (TestBlockType c : TestBlockType.values())
    System.out.println(c);

Returns:

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

valueOf

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