io.cucumber.java8.LambdaGlue Maven / Gradle / Ivy
package io.cucumber.java8;
import org.apiguardian.api.API;
@API(status = API.Status.STABLE)
public interface LambdaGlue {
String[] NO_REPLACEMENT = {};
String EMPTY_TAG_EXPRESSION = "";
int DEFAULT_BEFORE_ORDER = 1000;
int DEFAULT_AFTER_ORDER = 1000;
/**
* Defines an before hook.
*
* @param body lambda to execute, takes {@link Scenario} as an argument
*/
default void Before(final HookBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addBeforeHookDefinition(new Java8HookDefinition(EMPTY_TAG_EXPRESSION, DEFAULT_BEFORE_ORDER, body));
}
/**
* Defines an before hook.
*
* @param tagExpression a tag expression, if the expression applies to the
* current scenario this hook will be executed
* @param body lambda to execute, takes {@link Scenario} as an
* argument
*/
default void Before(String tagExpression, final HookBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addBeforeHookDefinition(new Java8HookDefinition(tagExpression, DEFAULT_BEFORE_ORDER, body));
}
/**
* Defines an before hook.
*
* @param order the order in which this hook should run. Higher numbers are
* run first
* @param body lambda to execute, takes {@link Scenario} as an argument
*/
default void Before(int order, final HookBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addBeforeHookDefinition(new Java8HookDefinition(EMPTY_TAG_EXPRESSION, order, body));
}
/**
* Defines an before hook.
*
* @param tagExpression a tag expression, if the expression applies to the
* current scenario this hook will be executed
* @param order the order in which this hook should run. Higher
* numbers are run first
* @param body lambda to execute, takes {@link Scenario} as an
* argument
*/
default void Before(String tagExpression, int order, final HookBody body) {
LambdaGlueRegistry.INSTANCE.get().addBeforeHookDefinition(new Java8HookDefinition(tagExpression, order, body));
}
/**
* Defines an before hook.
*
* @param body lambda to execute, takes {@link Scenario} as an argument
*/
default void Before(final HookNoArgsBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addBeforeHookDefinition(new Java8HookDefinition(EMPTY_TAG_EXPRESSION, DEFAULT_BEFORE_ORDER, body));
}
/**
* Defines an before hook.
*
* @param tagExpression a tag expression, if the expression applies to the
* current scenario this hook will be executed
* @param body lambda to execute
*/
default void Before(String tagExpression, final HookNoArgsBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addBeforeHookDefinition(new Java8HookDefinition(tagExpression, DEFAULT_BEFORE_ORDER, body));
}
/**
* Defines an before hook.
*
* @param order the order in which this hook should run. Higher numbers are
* run first
* @param body lambda to execute
*/
default void Before(int order, final HookNoArgsBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addBeforeHookDefinition(new Java8HookDefinition(EMPTY_TAG_EXPRESSION, order, body));
}
/**
* Defines an before hook.
*
* @param tagExpression a tag expression, if the expression applies to the
* current scenario this hook will be executed
* @param order the order in which this hook should run. Higher
* numbers are run first
* @param body lambda to execute
*/
default void Before(String tagExpression, int order, final HookNoArgsBody body) {
LambdaGlueRegistry.INSTANCE.get().addBeforeHookDefinition(new Java8HookDefinition(tagExpression, order, body));
}
/**
* Defines an before step hook.
*
* @param body lambda to execute, takes {@link Scenario} as an argument
*/
default void BeforeStep(final HookBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addBeforeStepHookDefinition(new Java8HookDefinition(EMPTY_TAG_EXPRESSION, DEFAULT_BEFORE_ORDER, body));
}
/**
* Defines an before step hook.
*
* @param tagExpression a tag expression, if the expression applies to the
* current scenario this hook will be executed
* @param body lambda to execute, takes {@link Scenario} as an
* argument
*/
default void BeforeStep(String tagExpression, final HookBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addBeforeStepHookDefinition(new Java8HookDefinition(tagExpression, DEFAULT_BEFORE_ORDER, body));
}
/**
* Defines an before step hook.
*
* @param order the order in which this hook should run. Higher numbers are
* run first
* @param body lambda to execute, takes {@link Scenario} as an argument
*/
default void BeforeStep(int order, final HookBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addBeforeStepHookDefinition(new Java8HookDefinition(EMPTY_TAG_EXPRESSION, order, body));
}
/**
* Defines an before step hook.
*
* @param tagExpression a tag expression, if the expression applies to the
* current scenario this hook will be executed
* @param order the order in which this hook should run. Higher
* numbers are run first
* @param body lambda to execute, takes {@link Scenario} as an
* argument
*/
default void BeforeStep(String tagExpression, int order, final HookBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addBeforeStepHookDefinition(new Java8HookDefinition(tagExpression, order, body));
}
/**
* Defines an before step hook.
*
* @param body lambda to execute
*/
default void BeforeStep(final HookNoArgsBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addBeforeStepHookDefinition(new Java8HookDefinition(EMPTY_TAG_EXPRESSION, DEFAULT_BEFORE_ORDER, body));
}
/**
* Defines an before step hook.
*
* @param tagExpression a tag expression, if the expression applies to the
* current scenario this hook will be executed
* @param body lambda to execute
*/
default void BeforeStep(String tagExpression, final HookNoArgsBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addBeforeStepHookDefinition(new Java8HookDefinition(tagExpression, DEFAULT_BEFORE_ORDER, body));
}
/**
* Defines an before step hook.
*
* @param order the order in which this hook should run. Higher numbers are
* run first
* @param body lambda to execute
*/
default void BeforeStep(int order, final HookNoArgsBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addBeforeStepHookDefinition(new Java8HookDefinition(EMPTY_TAG_EXPRESSION, order, body));
}
/**
* Defines an before step hook.
*
* @param tagExpression a tag expression, if the expression applies to the
* current scenario this hook will be executed
* @param order the order in which this hook should run. Higher
* numbers are run first
* @param body lambda to execute
*/
default void BeforeStep(String tagExpression, int order, final HookNoArgsBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addBeforeStepHookDefinition(new Java8HookDefinition(tagExpression, order, body));
}
/**
* Defines an after hook.
*
* @param body lambda to execute, takes {@link Scenario} as an argument
*/
default void After(final HookBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addAfterHookDefinition(new Java8HookDefinition(EMPTY_TAG_EXPRESSION, DEFAULT_AFTER_ORDER, body));
}
/**
* Defines an after hook.
*
* @param tagExpression a tag expression, if the expression applies to the
* current scenario this hook will be executed
* @param body lambda to execute, takes {@link Scenario} as an
* argument
*/
default void After(String tagExpression, final HookBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addAfterHookDefinition(new Java8HookDefinition(tagExpression, DEFAULT_AFTER_ORDER, body));
}
/**
* Defines an after hook.
*
* @param order the order in which this hook should run. Higher numbers are
* run first
* @param body lambda to execute, takes {@link Scenario} as an argument
*/
default void After(int order, final HookBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addAfterHookDefinition(new Java8HookDefinition(EMPTY_TAG_EXPRESSION, order, body));
}
/**
* Defines and after hook.
*
* @param tagExpression a tag expression, if the expression applies to the
* current scenario this hook will be executed
* @param order the order in which this hook should run. Higher
* numbers are run first
* @param body lambda to execute, takes {@link Scenario} as an
* argument
*/
default void After(String tagExpression, int order, final HookBody body) {
LambdaGlueRegistry.INSTANCE.get().addAfterHookDefinition(new Java8HookDefinition(tagExpression, order, body));
}
/**
* Defines and after hook.
*
* @param body lambda to execute
*/
default void After(final HookNoArgsBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addAfterHookDefinition(new Java8HookDefinition(EMPTY_TAG_EXPRESSION, DEFAULT_AFTER_ORDER, body));
}
/**
* Defines and after hook.
*
* @param tagExpression a tag expression, if the expression applies to the
* current scenario this hook will be executed
* @param body lambda to execute
*/
default void After(String tagExpression, final HookNoArgsBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addAfterHookDefinition(new Java8HookDefinition(tagExpression, DEFAULT_AFTER_ORDER, body));
}
/**
* Defines and after hook.
*
* @param order the order in which this hook should run. Higher numbers are
* run first
* @param body lambda to execute
*/
default void After(int order, final HookNoArgsBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addAfterHookDefinition(new Java8HookDefinition(EMPTY_TAG_EXPRESSION, order, body));
}
/**
* Defines and after hook.
*
* @param tagExpression a tag expression, if the expression applies to the
* current scenario this hook will be executed
* @param order the order in which this hook should run. Higher
* numbers are run first
* @param body lambda to execute
*/
default void After(String tagExpression, int order, final HookNoArgsBody body) {
LambdaGlueRegistry.INSTANCE.get().addAfterHookDefinition(new Java8HookDefinition(tagExpression, order, body));
}
/**
* Defines and after step hook.
*
* @param body lambda to execute, takes {@link Scenario} as an argument
*/
default void AfterStep(final HookBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addAfterStepHookDefinition(new Java8HookDefinition(EMPTY_TAG_EXPRESSION, DEFAULT_AFTER_ORDER, body));
}
/**
* Defines and after step hook.
*
* @param tagExpression a tag expression, if the expression applies to the
* current scenario this hook will be executed
* @param body lambda to execute, takes {@link Scenario} as an
* argument
*/
default void AfterStep(String tagExpression, final HookBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addAfterStepHookDefinition(new Java8HookDefinition(tagExpression, DEFAULT_AFTER_ORDER, body));
}
/**
* Defines and after step hook.
*
* @param order the order in which this hook should run. Higher numbers are
* run first
* @param body lambda to execute, takes {@link Scenario} as an argument
*/
default void AfterStep(int order, final HookBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addAfterStepHookDefinition(new Java8HookDefinition(EMPTY_TAG_EXPRESSION, order, body));
}
/**
* Defines and after step hook.
*
* @param tagExpression a tag expression, if the expression applies to the
* current scenario this hook will be executed
* @param order the order in which this hook should run. Higher
* numbers are run first
* @param body lambda to execute, takes {@link Scenario} as an
* argument
*/
default void AfterStep(String tagExpression, int order, final HookBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addAfterStepHookDefinition(new Java8HookDefinition(tagExpression, order, body));
}
/**
* Defines and after step hook.
*
* @param body lambda to execute
*/
default void AfterStep(final HookNoArgsBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addAfterStepHookDefinition(new Java8HookDefinition(EMPTY_TAG_EXPRESSION, DEFAULT_AFTER_ORDER, body));
}
/**
* Defines and after step hook.
*
* @param tagExpression a tag expression, if the expression applies to the
* current scenario this hook will be executed
* @param body lambda to execute
*/
default void AfterStep(String tagExpression, final HookNoArgsBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addAfterStepHookDefinition(new Java8HookDefinition(tagExpression, DEFAULT_AFTER_ORDER, body));
}
/**
* Defines and after step hook.
*
* @param order the order in which this hook should run. Higher numbers are
* run first
* @param body lambda to execute
*/
default void AfterStep(int order, final HookNoArgsBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addAfterStepHookDefinition(new Java8HookDefinition(EMPTY_TAG_EXPRESSION, order, body));
}
/**
* Defines and after step hook.
*
* @param tagExpression a tag expression, if the expression applies to the
* current scenario this hook will be executed
* @param order the order in which this hook should run. Higher
* numbers are run first
* @param body lambda to execute
*/
default void AfterStep(String tagExpression, int order, final HookNoArgsBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addAfterStepHookDefinition(new Java8HookDefinition(tagExpression, order, body));
}
/**
* Register doc string type.
*
* @param contentType Name of the content type.
* @param body a function that creates an instance of
* type from the doc string
* @see io.cucumber.docstring.DocStringType
*/
default void DocStringType(String contentType, DocStringDefinitionBody body) {
LambdaGlueRegistry.INSTANCE.get().addDocStringType(new Java8DocStringTypeDefinition(contentType, body));
}
/**
* Register a data table type.
*
* @param the data table type
* @param body a function that creates an instance of type from
* the data table
*/
default void DataTableType(DataTableEntryDefinitionBody body) {
LambdaGlueRegistry.INSTANCE.get().addDataTableType(new Java8DataTableEntryDefinition(NO_REPLACEMENT, body));
}
/**
* Register a data table type with a replacement.
*
* A data table can only represent absent and non-empty strings. By
* replacing a known value (for example [empty]) a data table can also
* represent empty strings.
*
* @param the data table type
* @param replaceWithEmptyString a string that will be replaced with an
* empty string.
* @param body a function that creates an instance of
* type from the data table
*/
default void DataTableType(String replaceWithEmptyString, DataTableEntryDefinitionBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addDataTableType(new Java8DataTableEntryDefinition(new String[] { replaceWithEmptyString }, body));
}
/**
* Register a data table type
*
* @param body a function that creates an instance of type from
* the data table
* @param the data table type
*/
default void DataTableType(DataTableRowDefinitionBody body) {
LambdaGlueRegistry.INSTANCE.get().addDataTableType(new Java8DataTableRowDefinition(NO_REPLACEMENT, body));
}
/**
* Register a data table type with a replacement.
*
* A data table can only represent absent and non-empty strings. By
* replacing a known value (for example [empty]) a data table can also
* represent empty strings.
*
* @param the data table type
* @param replaceWithEmptyString a string that will be replaced with an
* empty string.
* @param body a function that creates an instance of
* type from the data table
*/
default void DataTableType(String replaceWithEmptyString, DataTableRowDefinitionBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addDataTableType(new Java8DataTableRowDefinition(new String[] { replaceWithEmptyString }, body));
}
/**
* Register a data table type
*
* @param body a function that creates an instance of type from
* the data table
* @param the data table type
*/
default void DataTableType(DataTableCellDefinitionBody body) {
LambdaGlueRegistry.INSTANCE.get().addDataTableType(new Java8DataTableCellDefinition(NO_REPLACEMENT, body));
}
/**
* Register a data table type with a replacement.
*
* A data table can only represent absent and non-empty strings. By
* replacing a known value (for example [empty]) a data table can also
* represent empty strings.
*
* @param the data table type
* @param replaceWithEmptyString a string that will be replaced with an
* empty string.
* @param body a function that creates an instance of
* type from the data table
*/
default void DataTableType(String replaceWithEmptyString, DataTableCellDefinitionBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addDataTableType(new Java8DataTableCellDefinition(new String[] { replaceWithEmptyString }, body));
}
/**
* Register a data table type
*
* @param body a function that creates an instance of type from
* the data table
* @param the data table type
*/
default void DataTableType(DataTableDefinitionBody body) {
LambdaGlueRegistry.INSTANCE.get().addDataTableType(new Java8DataTableDefinition(NO_REPLACEMENT, body));
}
/**
* Register a data table type with a replacement.
*
* A data table can only represent absent and non-empty strings. By
* replacing a known value (for example [empty]) a data table can also
* represent empty strings.
*
* @param the data table type
* @param replaceWithEmptyString a string that will be replaced with an
* empty string.
* @param body a function that creates an instance of
* type from the data table
*/
default void DataTableType(String replaceWithEmptyString, DataTableDefinitionBody body) {
LambdaGlueRegistry.INSTANCE.get()
.addDataTableType(new Java8DataTableDefinition(new String[] { replaceWithEmptyString }, body));
}
/**
* Register parameter type.
*
* @param the parameter type
* {@link io.cucumber.cucumberexpressions.ParameterType#getType()}
* @param name used as the type name in typed expressions
* {@link io.cucumber.cucumberexpressions.ParameterType#getName()}
* @param regex expression to match
* @param definitionBody converts {@code String} argument to the target
* parameter type
* @see io.cucumber.cucumberexpressions.ParameterType
* @see Cucumber
* Expressions
*/
default void ParameterType(String name, String regex, ParameterDefinitionBody.A1 definitionBody) {
LambdaGlueRegistry.INSTANCE.get().addParameterType(
new Java8ParameterTypeDefinition(name, regex, ParameterDefinitionBody.A1.class, definitionBody));
}
/**
* Register parameter type.
*
* @param the parameter type.
* {@link io.cucumber.cucumberexpressions.ParameterType#getType()}
* @param name used as the type name in typed expressions.
* {@link io.cucumber.cucumberexpressions.ParameterType#getName()}
* @param regex expression to match. If the expression includes
* capture groups their captured strings will be
* provided as individual arguments.
* @param definitionBody converts {@code String} arguments to the target
* parameter type
* @see io.cucumber.cucumberexpressions.ParameterType
* @see Cucumber
* Expressions
*/
default void ParameterType(String name, String regex, ParameterDefinitionBody.A2 definitionBody) {
LambdaGlueRegistry.INSTANCE.get().addParameterType(
new Java8ParameterTypeDefinition(name, regex, ParameterDefinitionBody.A2.class, definitionBody));
}
/**
* @see LambdaGlue#ParameterType(String, String,
* io.cucumber.java8.ParameterDefinitionBody.A2)
*/
default void ParameterType(String name, String regex, ParameterDefinitionBody.A3 definitionBody) {
LambdaGlueRegistry.INSTANCE.get().addParameterType(
new Java8ParameterTypeDefinition(name, regex, ParameterDefinitionBody.A3.class, definitionBody));
}
/**
* @see LambdaGlue#ParameterType(String, String,
* io.cucumber.java8.ParameterDefinitionBody.A2)
*/
default void ParameterType(String name, String regex, ParameterDefinitionBody.A4 definitionBody) {
LambdaGlueRegistry.INSTANCE.get().addParameterType(
new Java8ParameterTypeDefinition(name, regex, ParameterDefinitionBody.A4.class, definitionBody));
}
/**
* @see LambdaGlue#ParameterType(String, String,
* io.cucumber.java8.ParameterDefinitionBody.A2)
*/
default void ParameterType(String name, String regex, ParameterDefinitionBody.A5 definitionBody) {
LambdaGlueRegistry.INSTANCE.get().addParameterType(
new Java8ParameterTypeDefinition(name, regex, ParameterDefinitionBody.A5.class, definitionBody));
}
/**
* @see LambdaGlue#ParameterType(String, String,
* io.cucumber.java8.ParameterDefinitionBody.A2)
*/
default void ParameterType(String name, String regex, ParameterDefinitionBody.A6 definitionBody) {
LambdaGlueRegistry.INSTANCE.get().addParameterType(
new Java8ParameterTypeDefinition(name, regex, ParameterDefinitionBody.A6.class, definitionBody));
}
/**
* @see LambdaGlue#ParameterType(String, String,
* io.cucumber.java8.ParameterDefinitionBody.A2)
*/
default void ParameterType(String name, String regex, ParameterDefinitionBody.A7 definitionBody) {
LambdaGlueRegistry.INSTANCE.get().addParameterType(
new Java8ParameterTypeDefinition(name, regex, ParameterDefinitionBody.A7.class, definitionBody));
}
/**
* @see LambdaGlue#ParameterType(String, String,
* io.cucumber.java8.ParameterDefinitionBody.A2)
*/
default void ParameterType(String name, String regex, ParameterDefinitionBody.A8 definitionBody) {
LambdaGlueRegistry.INSTANCE.get().addParameterType(
new Java8ParameterTypeDefinition(name, regex, ParameterDefinitionBody.A8.class, definitionBody));
}
/**
* @see LambdaGlue#ParameterType(String, String,
* io.cucumber.java8.ParameterDefinitionBody.A2)
*/
default void ParameterType(String name, String regex, ParameterDefinitionBody.A9 definitionBody) {
LambdaGlueRegistry.INSTANCE.get().addParameterType(
new Java8ParameterTypeDefinition(name, regex, ParameterDefinitionBody.A9.class, definitionBody));
}
/**
* Register default parameter type transformer.
*
* @param definitionBody converts {@code String} argument to an instance of
* the {@code Type} argument
*/
default void DefaultParameterTransformer(DefaultParameterTransformerBody definitionBody) {
LambdaGlueRegistry.INSTANCE.get()
.addDefaultParameterTransformer(new Java8DefaultParameterTypeDefinition(definitionBody));
}
/**
* Register default data table cell transformer.
*
* @param definitionBody converts {@code String} argument to an instance of
* the {@code Type} argument
*/
default void DefaultDataTableCellTransformer(DefaultDataTableCellTransformerBody definitionBody) {
LambdaGlueRegistry.INSTANCE.get().addDefaultDataTableCellTransformer(
new Java8DefaultDataTableCellTransformerDefinition(NO_REPLACEMENT, definitionBody));
}
/**
* Register default data table cell transformer with a replacement.
*
* A data table can only represent absent and non-empty strings. By
* replacing a known value (for example [empty]) a data table can also
* represent empty strings. *
*
* @param replaceWithEmptyString a string that will be replaced with an
* empty string.
* @param definitionBody converts {@code String} argument to an
* instance of the {@code Type} argument
*/
default void DefaultDataTableCellTransformer(
String replaceWithEmptyString, DefaultDataTableCellTransformerBody definitionBody
) {
LambdaGlueRegistry.INSTANCE.get().addDefaultDataTableCellTransformer(
new Java8DefaultDataTableCellTransformerDefinition(new String[] { replaceWithEmptyString },
definitionBody));
}
/**
* Register default data table entry transformer.
*
* @param definitionBody converts {@code Map} argument to an
* instance of the {@code Type} argument
*/
default void DefaultDataTableEntryTransformer(DefaultDataTableEntryTransformerBody definitionBody) {
LambdaGlueRegistry.INSTANCE.get().addDefaultDataTableEntryTransformer(
new Java8DefaultDataTableEntryTransformerDefinition(NO_REPLACEMENT, definitionBody));
}
/**
* Register default data table cell transformer with a replacement.
*
* A data table can only represent absent and non-empty strings. By
* replacing a known value (for example [empty]) a data table can also
* represent empty strings.
*
* @param replaceWithEmptyString a string that will be replaced with an
* empty string.
* @param definitionBody converts {@code Map}
* argument to an instance of the {@code Type}
* argument
*/
default void DefaultDataTableEntryTransformer(
String replaceWithEmptyString, DefaultDataTableEntryTransformerBody definitionBody
) {
LambdaGlueRegistry.INSTANCE.get().addDefaultDataTableEntryTransformer(
new Java8DefaultDataTableEntryTransformerDefinition(new String[] { replaceWithEmptyString },
definitionBody));
}
}