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

Enum TemplateCustomFieldPattern

java.lang.Object

java.lang.Enum<TemplateCustomFieldPattern>

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

All Implemented Interfaces:

Serializable, Comparable<TemplateCustomFieldPattern>

public enum TemplateCustomFieldPattern
extends Enum<TemplateCustomFieldPattern>

Enum which defines custom field pattern used in import template.

Author:

Gregory Fouquet

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO_CUSTOM_FIELD
REQUIREMENT_VERSION_CUSTOM_FIELD
STEP_CUSTOM_FIELD
TEST_CASE_CUSTOM_FIELD

Method Summary

Methods

Modifier and Type	Method and Description
String	parseFieldCode(String header) Parses a custom field code from a column header.
static TemplateCustomFieldPattern	valueOf(String name) Returns the enum constant of this type with the specified name.
static TemplateCustomFieldPattern[]	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

TEST_CASE_CUSTOM_FIELD

public static final TemplateCustomFieldPattern TEST_CASE_CUSTOM_FIELD

STEP_CUSTOM_FIELD

public static final TemplateCustomFieldPattern STEP_CUSTOM_FIELD

REQUIREMENT_VERSION_CUSTOM_FIELD

public static final TemplateCustomFieldPattern REQUIREMENT_VERSION_CUSTOM_FIELD

NO_CUSTOM_FIELD

public static final TemplateCustomFieldPattern NO_CUSTOM_FIELD

Method Detail

values

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

Returns:

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

valueOf

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

parseFieldCode

public String parseFieldCode(String header)

Parses a custom field code from a column header. Headers leading to a blank code will be considered as non-parsing and produce a null result.

Parameters:

header -

Returns:

the field code. When the header don't parse, returns null.