com.asakusafw.testdriver.excel

Enum RuleSheetFormat

java.lang.Object

java.lang.Enum<RuleSheetFormat>

com.asakusafw.testdriver.excel.RuleSheetFormat

All Implemented Interfaces:

Serializable, Comparable<RuleSheetFormat>

public enum RuleSheetFormat
extends Enum<RuleSheetFormat>

Format of verification rule description on Excel Sheet.

Since:

0.7.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMMENTS Title of comments of property.
EXTRA_OPTIONS Title of options of property.
FORMAT Title of the sheet format.
NULLITY_CONDITION Title of the condition of property's nullity.
PROPERTY_NAME Title of property names.
TOTAL_CONDITION Title of the total condition.
VALUE_CONDITION Title of the condition of property's value.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORMAT_VERSION Format ID which this extractor supports.

Method Summary

Modifier and Type	Method and Description
int	getColumnIndex() Returns the column index where this kind assigned in a sheet.
int	getRowIndex() Returns the row index where this kind assigned in a sheet.
String	getTitle() Returns the title of this kind.
static RuleSheetFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static RuleSheetFormat[]	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

FORMAT

public static final RuleSheetFormat FORMAT

Title of the sheet format. This title must be "Format", it is used for detect the format of each sheet. The format kind must be set on the immediate right cell.

TOTAL_CONDITION

public static final RuleSheetFormat TOTAL_CONDITION

Title of the total condition. The total condition kind must be set on the immediate right cell, and it must be one of TotalConditionKind.getOptions().

PROPERTY_NAME

public static final RuleSheetFormat PROPERTY_NAME

Title of property names. Each property name must be set on the same column below this cell, and it must be form of "snake_case".

VALUE_CONDITION

public static final RuleSheetFormat VALUE_CONDITION

Title of the condition of property's value. Each item must be set on the same column below this cell, and it must be one of ValueConditionKind.getOptions().

NULLITY_CONDITION

public static final RuleSheetFormat NULLITY_CONDITION

Title of the condition of property's nullity. Each item must be set on the same column below this cell, and it must be one of NullityConditionKind.getOptions().

COMMENTS

public static final RuleSheetFormat COMMENTS

Title of comments of property. Each item must be set on the same column below this cell.

EXTRA_OPTIONS

public static final RuleSheetFormat EXTRA_OPTIONS

Title of options of property. Each item must be set on the same column below this cell.

Field Detail

FORMAT_VERSION

public static final String FORMAT_VERSION

Format ID which this extractor supports. This must be set on the right cell of FORMAT.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static RuleSheetFormat valueOf(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:

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

NullPointerException - if the argument is null

getTitle

public String getTitle()

Returns the title of this kind.

Returns:

the title

getRowIndex

public int getRowIndex()

Returns the row index where this kind assigned in a sheet.

Returns:

the row index (0-origin)

getColumnIndex

public int getColumnIndex()

Returns the column index where this kind assigned in a sheet.

Returns:

the column index (0-origin)