Package com.arc_e_tect.gradle.gherkin.indexing

Enum Class IndexingMode

java.lang.Object

java.lang.Enum<IndexingMode>

com.arc_e_tect.gradle.gherkin.indexing.IndexingMode

All Implemented Interfaces:

Serializable, Comparable<IndexingMode>, Constable

public enum IndexingMode
extends Enum<IndexingMode>

Controls whether Feature/Scenario titles are numbered directly in the source .feature files, as configured via the indexing DSL property.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Both features and scenarios are numbered.
CI	Indexing is skipped entirely: the source .feature files are left completely untouched, not even to strip numbering left over from a previous run - unlike OFF, which does strip it.
FEATURE	Every feature is numbered, in the order its feature file is processed in - see GherkinToAsciidocExtension#getIndexing() for exactly what that order is - e.g.
OFF	Nothing is numbered.
SCENARIO	Every scenario is numbered, continuously across all feature files, in the same file processing order as FEATURE, e.g.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OFF

public static final IndexingMode OFF

Nothing is numbered. Any numbering left over from a previous run is removed.

FEATURE

public static final IndexingMode FEATURE

Every feature is numbered, in the order its feature file is processed in - see GherkinToAsciidocExtension#getIndexing() for exactly what that order is - e.g. Feature: 1 - User authentication.

SCENARIO

public static final IndexingMode SCENARIO

Every scenario is numbered, continuously across all feature files, in the same file processing order as FEATURE, e.g. Scenario: 1 - User logs in.

ALL

public static final IndexingMode ALL

Both features and scenarios are numbered. Scenarios are numbered per feature as <featureNumber>.<scenarioNumber>, e.g. Scenario: 1.1 - User logs in within Feature: 1 - User authentication.

CI

public static final IndexingMode CI

Indexing is skipped entirely: the source .feature files are left completely untouched, not even to strip numbering left over from a previous run - unlike OFF, which does strip it. Intended to be set via the -PgherkinToAsciidoc.indexing=ci command-line override (see GherkinToAsciidocExtension#getIndexing()) so a CI pipeline never mutates source files, regardless of the indexing value configured in the build script - but it can also be configured directly like any other value.

Method Details

values

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