org.squashtest.tm.service.internal.batchimport.testcase.excel

Enum TemplateWorksheet

java.lang.Object

java.lang.Enum<TemplateWorksheet>

org.squashtest.tm.service.internal.batchimport.testcase.excel.TemplateWorksheet

All Implemented Interfaces:

Serializable, Comparable<TemplateWorksheet>

public enum TemplateWorksheet
extends Enum<TemplateWorksheet>

Enum of worksheet which are expected in the import file.

Author:

Gregory Fouquet

Enum Constant Summary

Enum Constants

Enum Constant and Description
COVERAGE_SHEET
DATASET_PARAM_VALUES_SHEET
DATASETS_SHEET
PARAMETERS_SHEET
REQUIREMENT_LINKS_SHEET
REQUIREMENT_SHEET
STEPS_SHEET
TEST_CASES_SHEET

Field Summary

Fields

Modifier and Type	Field and Description
Class<? extends Enum<?>>	columnTypesClass
TemplateCustomFieldPattern	customFieldPattern
String	sheetName

Method Summary

Methods

Modifier and Type	Method and Description
static Collection<TemplateWorksheet>	coerceFromSheetName(String name) Returns the enum value matching the given sheet name.
<E extends TemplateColumn> E[]	getColumnTypes()
static TemplateWorksheet	valueOf(String name) Returns the enum constant of this type with the specified name.
static TemplateWorksheet[]	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

REQUIREMENT_SHEET

public static final TemplateWorksheet REQUIREMENT_SHEET

TEST_CASES_SHEET

public static final TemplateWorksheet TEST_CASES_SHEET

STEPS_SHEET

public static final TemplateWorksheet STEPS_SHEET

PARAMETERS_SHEET

public static final TemplateWorksheet PARAMETERS_SHEET

DATASETS_SHEET

public static final TemplateWorksheet DATASETS_SHEET

DATASET_PARAM_VALUES_SHEET

public static final TemplateWorksheet DATASET_PARAM_VALUES_SHEET

COVERAGE_SHEET

public static final TemplateWorksheet COVERAGE_SHEET

REQUIREMENT_LINKS_SHEET

public static final TemplateWorksheet REQUIREMENT_LINKS_SHEET

Field Detail

sheetName

public final String sheetName

columnTypesClass

public final Class<? extends Enum<?>> columnTypesClass

customFieldPattern

public final TemplateCustomFieldPattern customFieldPattern

Method Detail

values

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

Returns:

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

valueOf

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

coerceFromSheetName

public static Collection<TemplateWorksheet> coerceFromSheetName(String name)

Returns the enum value matching the given sheet name.

Parameters:

name -

Returns:

the matching enum, null when no match.

getColumnTypes

public <E extends TemplateColumn> E[] getColumnTypes()