| Interface | Description |
|---|---|
| AsProvider |
Provides a representation of a stage method, scenario or scenario class.
|
| CaseAsProvider |
Provides the description of a scenario case.
|
| CaseDescriptionProvider | Deprecated
since 0.15.0 please use
CaseAsProvider |
| TagDescriptionGenerator |
Is used as an attribute of the
IsTag annotation
to dynamically generate a description for an annotation depending on its value. |
| TagHrefGenerator |
Is used as an attribute of the
IsTag annotation
to dynamically generate an href for an annotation depending on its value. |
| Enum | Description |
|---|---|
| POJOFormat.BracketsEnum |
Enumeration of opening/closing brackets pair :
POJOFormat.BracketsEnum.NONE : no brackets
POJOFormat.BracketsEnum.PARENTHESES : (...)
POJOFormat.BracketsEnum.SQUARE : [...]
POJOFormat.BracketsEnum.BRACES : {...}
POJOFormat.BracketsEnum.POINTY : <...>
POJOFormat.BracketsEnum.CHEVRONS : <<...>>
POJOFormat.BracketsEnum.DOUBLE_QUOTE : "..."
POJOFormat.BracketsEnum.SINGLE_QUOTE : '...'
|
| ScenarioState.Resolution | |
| Table.HeaderType | |
| Table.ObjectFormatting |
Possible choices for the
Table.objectFormatting() attribute. |
| Annotation Type | Description |
|---|---|
| AfterScenario |
Marks methods to be executed after the whole Scenario has been executed.
|
| AfterStage |
Marks methods to be executed after a stage has been executed.
|
| AnnotationFormat |
Allows arguments of step methods to be formatted with an
AnnotationArgumentFormatter. |
| As |
This annotation can be used to override the default
representation for a step method, test method or class name in the report.
|
| BeforeScenario |
Marks methods to be executed before the whole Scenario has been executed.
|
| BeforeStage |
Marks methods to be executed before a stage is executed,
i.e.
|
| CaseAs |
Use to define a description provider for scenario cases.
|
| CaseDescription | Deprecated
Since v0.15.0 this annotation is deprecated because it starts the argument enumeration from 0 and not from 1,
like
As. |
| Description |
This annotation can be used to provide a description for a test class.
|
| DoNotIntercept |
Methods of stages classes annotated with this annotation will not be intercepted by JGiven.
|
| ExpectedScenarioState |
Marks fields to be expected by a scenario stage.
|
| ExtendedDescription |
This annotation can be used to define an extended description for a step method or a test method.
|
| Format |
Allows arguments of step methods to be formatted with an ArgumentFormatter.
|
| Formatf |
A special format annotation that uses the formatting
known from the String.format method.
|
| Hidden |
Annotates elements that should be hidden in reports.
|
| IntroWord |
Marks a method as an introduction word of a step.
|
| IsTag |
Marks an annotation to be used as a tag in JGiven reports.
|
| JGivenConfiguration |
This annotation can be applied to a test class to configure:
Tags
Global formatter
|
| NamedFormat |
Allow to specify an identifiable format
|
| NamedFormats |
Allow to define a set of identifiable formats (
NamedFormat).One usage of such set is to define formats for (part or all) fields of a bean. |
| NestedSteps |
Marks a step method to have nested steps.
|
| NotImplementedYet | Deprecated
use
Pending instead |
| Pending |
Marks methods of step definitions as not implemented yet.
|
| POJOFormat |
A special format annotation to format POJOs
|
| ProvidedScenarioState |
Marks fields to be provided by a scenario stage.
|
| Quoted |
Step parameters annotated with this annotation will be put into quotes (" ") in reports.
|
| ScenarioRule |
Marks fields to be Scenario rules.
|
| ScenarioStage |
Marks fields to be stage instances
This is useful to reuse stages within stages.
|
| ScenarioState |
Marks fields to be read and/or written by a scenario stage.
|
| SingleQuoted |
Step parameters annotated with this annotation will be put into quotes (' ') in reports.
|
| StepComment |
Marks a method to be used to provide an additional comment to the previous step.
|
| Table |
Marks the parameter of a step method as a data table.
|