All Classes

Class	Description
AbstractJGivenConfiguration
AbstractReportConfig	Basic configuration for a report with an extendable interface The configMap should always be in a valid state and have all possible flags, except the optional ones without a default (like --help) For examples see AsciiDocReportConfig
AbstractReportGenerator	This abstract class is the basic layout that includes the minimal functionality for reading/writing a report The following flags are predefined in AbstractReportConfig.createConfigOptions(): --format= --sourceDir= /--dir= --targetDir= /--todir= --title= --exclude-empty-scenarios=<boolean> --help / -h Everything has a default value.
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.
AmbiguousResolutionException	Thrown when a field cannot be uniquely resolved by the name or type.
AnnotationArgumentFormatter<T extends java.lang.annotation.Annotation>	Interface for defining a formatter for a custom annotation using the AnnotationFormat annotation.
AnnotationFormat	Allows arguments of step methods to be formatted with an AnnotationArgumentFormatter.
ArgumentFormatter<T>	Interface for defining custom argument formatter using the Format annotation.
ArgumentInfo
As	This annotation can be used to override the default representation for a step method, test method or class name in the report.
AsciiDocReportConfig	Configuration for the AsciiDoc report.
AsciiDocReportGenerator	This reporter provides the functionality for reading/writing a report in AsciiDoc format.
AsProvider	Provides a representation of a stage method, scenario or scenario class.
Attachment	Represents an attachment of a step.
AttachmentModel
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.
BooleanFormatter	General formatter to format boolean values.
CanWire
CaseArgumentAnalyser	Analyzes a report model and tries to infer which step method arguments match to which case argument.
CaseAs	Use to define a description provider for scenario cases.
CaseAsProvider	Provides the description of a scenario case.
CaseDifferenceAnalyzer
CasesTable	Represents multiple scenario cases as a table structure for simpler reporting.
CasesTable.CaseRow	Represents one case of a scenario.
CasesTableCalculator	Calculates a table representation for all cases of a scenario.
CenarioTesteBase<DADO,QUANDO,ENTAO>
CommandLineOption	Defines a command line interface for use in ConfigOption with automatic help description generation used by ConfigOptionParser.printUsageAndExit(List) Instantiation through CommandLineOptionBuilder
CommandLineOptionBuilder	An easier interface to instantiate CommandLineOption for use in ConfigOption
CompleteReportModel	Represents the complete report model of all report files.
ConfigOption	Defines a configuration for the report which can be from the command line, property or the environment Instantiated with ConfigOptionBuilder For use in AbstractReportConfig.additionalConfigOptions(List) and the generated object map in AbstractReportConfig(String...)
ConfigOptionBuilder	An easier interface to create ConfigOption for use with AbstractReportGenerator
ConfigOptionParser
ConfigurationUtil
ConfigValue	Represents a configuration value
CurrentScenario	This interface can be injected into a stage using the ScenarioState annotation.
CurrentStep	This interface can be injected into a stage by using the ScenarioState annotation.
DataTable	Represents a data table argument.
DataTablePlainTextScenarioWriter
DataTables	A utility class to create data tables.
DateFormatter	General formatter to format Date values.
DefaultConfiguration
DefaultFormatter<T>	A default formatter that merely use String.valueOf(Object), except for arrays where Arrays.deepToString(Object[]) is used.
DefaultObjectFormatter	A default formatter for Object types
DefaultRowFormatterFactory	Default RowFormatterFactory that evaluates the Table.objectFormatting() attribute to create a RowFormatter.
DefaultTableFormatter	The default implementation to format a table argument
DefaultTableFormatter.Factory
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.
DualScenarioTestBase<GIVEN_WHEN,THEN>	ScenarioTest that only takes two type parameters, where the first is used for combined GIVEN and WHEN and the second is used for THEN.
EinfacheSzenarioTestBasis<STUFE>
EscenarioTestBase<DADO,CUANDO,ENTONCES>
Etapa<SELF extends Etapa<?>>	Uma versão em português da classe Stage.
Etape<SELF extends Etape<?>>	Une version française de la classe Stage.
ExecutionStatus
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.
FailIfPassedException
Fase<SELF extends Fase<?>>	Una versión en español de la clase Stage.
FieldBasedRowFormatter	Default implementation of the RowFormatter that uses the fields of an object as columns of the table
FieldBasedRowFormatter.Factory	Factory for creating instances of FieldBasedRowFormatter
FillerWord	Marks a method which will be used as a preamble to the next non-filler stage 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.
Formatter<T>	Interface for defining a global argument formatter.
FormatterConfiguration
Hidden	Annotates elements that should be hidden in reports.
IntroWord	Marks a method as an introduction word of a step.
InvocationMode
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
JGivenExecutionException	This exception is thrown when JGiven tried to execute a used defined method, but the method could not be executed for some reason.
JGivenInjectionException
JGivenInstallationException
JGivenInternalDefectException	If this exception is thrown there is most likely a bug in JGiven.
JGivenMissingGuaranteedScenarioStateException
JGivenMissingRequiredScenarioStateException	This exception is thrown if a scenario state has been marked as required, but the state has not been provided.
JGivenUserException	This exception is thrown when JGiven tried to execute a user-defined method and that method has thrown an exception.
JGivenWrongUsageException	Thrown when JGiven was used in some wrong way.
JsonModelTraverser
MediaType	Represents a (simplified) Media Type.
MediaType.Type	Represents the type of a Media Type
NamedArgument
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.
NotFormatter	Translates false to the word "not" and true to the empty word "".
ObjectFormatter<T>	General interface to format Objects to Strings
Pending	Marks methods of step definitions as not implemented yet.
PlainRowFormatter	Formats each row by just using the default formatting of an object.
PlainRowFormatter.Factory	Factory for creating instances of PlainRowFormatter
PlainTextReportConfig
PlainTextReporter	Generates a plain text report to a PrintStream.
PlainTextReportGenerator
PlainTextScenarioWriter
PlainTextTableWriter
PlainTextWriter
POJOAnnotationFormatter	AnnotationArgumentFormatter that is used by the POJOFormat annotation
POJOFormat	A special format annotation to format POJOs
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 : '...'
PrintfAnnotationFormatter	AnnotationArgumentFormatter that is used by the Formatf annotation
PrintfFormatter	Formatter to use a Java format string to format arguments.
ProvidedScenarioState	Marks fields to be provided by a scenario stage.
Quoted	Step parameters annotated with this annotation will be put into quotes (" ") in reports.
ReportBlockConverter	Converts elements of the report model into standalone text blocks.
ReportGenerator	This is an interface to create a report based on command line flags
ReportGenerator.Format	to create a custom report, extend this enum with the name of your choice
ReportModel
ReportModelFile
ReportModelFileHandler	Handles a single ReportModel that has been read from a single JSON file.
ReportModelReader
ReportModelVisitor
ReportStatistics
RowFormatter	Formats the rows of a data table.
RowFormatterFactory	Factory for creating ObjectRowFormatter instances
ScenarioCaseModel
ScenarioJsonReader
ScenarioJsonReader.JsonReaderException
ScenarioJsonWriter
ScenarioModel
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.
ScenarioState.Resolution
ScenarioTestBase<GIVEN,WHEN,THEN>	Base class for Scenario tests.
SimpleEscenarioTestBase<FASE>
SimpleScenarioTestBase<STEPS>	ScenarioTest that only takes a single type parameter that is used for all three step definition types.
SimplesCenarioTesteBase<ETAPA>
SimpleTestDeScenarioBase<ETAPE>
SingleQuoted	Step parameters annotated with this annotation will be put into quotes (' ') in reports.
Stage<SELF extends Stage<?>>	Base class for Stages.
StageBase<SELF extends StageBase<?>>	Useful base class for step definitions as it provides a StageBase.self() method to create fluent interfaces.
StatisticsCalculator
StepComment	Marks a method to be used to provide an additional comment to the previous step.
StepFormatter
StepFormatter.AnnotationBasedFormatter
StepFormatter.ArgumentFormatting<F extends ArgumentFormatter<T>,T>
StepFormatter.ChainedFormatting<T>
StepFormatter.Formatting<F,T>
StepFormatter.TableFormatting<F extends TableFormatter>
StepFormatter.TypeBasedFormatting<T>
StepFunction<STAGE>	A functional interface for defining ad-hoc steps.
StepModel
StepStatus
StringConverter	Interface to create converter function to specify the to map the incoming command line argument to the object See AbstractReportGenerator for example definitions of ConfigOption If the conversion is not possible, return null.
Stufe<SELF extends Stufe<?>>	Eine deutsche Version der Stage-Klasse.
SzenarioTestBasis<GEGEBEN,WENN,DANN>
Table	Marks the parameter of a step method as a data table.
Table.HeaderType
Table.ObjectFormatting	Possible choices for the Table.objectFormatting() attribute.
TableFormatter	Formatter that will format arguments as a table.
TableFormatterFactory	Factory to create a custom TableFormatter
Tag	A tag represents a Java annotation of a scenario-test.
TagConfiguration	Represents the configuration of a tag.
TagConfiguration.Builder
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.
TestDeScenarioBase<ETANT_DONNE,QUAND,ALORS>
ToBoolean	Total conversion function
ToFile	Total conversion function
ToFormat	Not total, if the format parse fails it returns null
ToString	Total conversion function
Word	Represents a part of a step.