Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
$
- $(String) - Method in class com.tngtech.jgiven.base.StageBase
-
A simple helper to provide a description
- $(String, StepFunction<? super SELF>) - Method in class com.tngtech.jgiven.base.StageBase
-
A step method for creating ad-hoc steps using lambdas.
A
- aber() - Method in class com.tngtech.jgiven.lang.de.Stufe
- ABORTED - Enum constant in enum class com.tngtech.jgiven.report.model.ExecutionStatus
- ABORTED - Enum constant in enum class com.tngtech.jgiven.report.model.StepStatus
- AbstractJGivenConfiguration - Class in com.tngtech.jgiven.config
- AbstractJGivenConfiguration() - Constructor for class com.tngtech.jgiven.config.AbstractJGivenConfiguration
- AbstractReportConfig - Class in com.tngtech.jgiven.report
-
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
- AbstractReportConfig() - Constructor for class com.tngtech.jgiven.report.AbstractReportConfig
- AbstractReportConfig(String...) - Constructor for class com.tngtech.jgiven.report.AbstractReportConfig
- AbstractReportGenerator - Class in com.tngtech.jgiven.report
-
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. - AbstractReportGenerator() - Constructor for class com.tngtech.jgiven.report.AbstractReportGenerator
- accept(ReportModelVisitor) - Method in class com.tngtech.jgiven.report.model.ReportModel
- accept(ReportModelVisitor) - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- accept(ReportModelVisitor) - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- accept(ReportModelVisitor) - Method in class com.tngtech.jgiven.report.model.StepModel
- add(ReportStatistics) - Method in class com.tngtech.jgiven.report.model.ReportStatistics
- addAttachment(Attachment) - Method in interface com.tngtech.jgiven.CurrentStep
-
Adds an attachment to the current step
- addAttachment(Attachment) - Method in class com.tngtech.jgiven.report.model.StepModel
- addCase(ScenarioCaseModel) - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- addColumn(int, List<String>) - Method in class com.tngtech.jgiven.report.model.DataTable
- addDerivedArguments(String...) - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- addDerivedParameter(String) - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- addDurationInNanos(long) - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- addExplicitArguments(String...) - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- addFormatting(StepFormatter.Formatting<?, String>) - Method in class com.tngtech.jgiven.report.model.StepFormatter.ChainedFormatting
- addIntroWord(Word) - Method in class com.tngtech.jgiven.report.model.StepModel
- additionalConfigOptions(List<ConfigOption>) - Method in class com.tngtech.jgiven.report.AbstractReportConfig
-
This is used to create new
ConfigOption
for theAbstractReportConfig
by appending them to the list - additionalConfigOptions(List<ConfigOption>) - Method in class com.tngtech.jgiven.report.asciidoc.AsciiDocReportConfig
- additionalConfigOptions(List<ConfigOption>) - Method in class com.tngtech.jgiven.report.text.PlainTextReportConfig
- addModelFile(ReportModelFile) - Method in class com.tngtech.jgiven.report.model.CompleteReportModel
- addNestedStep(StepModel) - Method in class com.tngtech.jgiven.report.model.StepModel
- addParameterNames(String...) - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- addPrefix(CharSequence) - Method in class com.tngtech.jgiven.report.model.Word
- addRow(int, List<String>) - Method in class com.tngtech.jgiven.report.model.DataTable
- addScenarioModel(ScenarioModel) - Method in class com.tngtech.jgiven.report.model.ReportModel
- addScenarioModelOrMergeWithExistingOne(ScenarioModel) - Method in class com.tngtech.jgiven.report.model.ReportModel
- addStage(Class<T>) - Method in class com.tngtech.jgiven.base.ScenarioTestBase
-
Add a new stage class to the scenario.
- addStep(StepModel) - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- addSuffix(CharSequence) - Method in class com.tngtech.jgiven.report.model.Word
- addTag(Tag) - Method in class com.tngtech.jgiven.report.model.ReportModel
- addTag(Tag) - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- addTag(Class<? extends Annotation>, String...) - Method in interface com.tngtech.jgiven.CurrentScenario
-
Dynamically add a tag to the scenario.
- addTags(Iterable<Tag>) - Method in class com.tngtech.jgiven.report.model.ReportModel
- addTags(List<Tag>) - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- addWords(Word...) - Method in class com.tngtech.jgiven.report.model.StepModel
- AfterScenario - Annotation Interface in com.tngtech.jgiven.annotation
-
Marks methods to be executed after the whole Scenario has been executed.
- AfterStage - Annotation Interface in com.tngtech.jgiven.annotation
-
Marks methods to be executed after a stage has been executed.
- allScenarios - Variable in class com.tngtech.jgiven.report.model.CompleteReportModel
- alors() - Method in class com.tngtech.jgiven.lang.fr.Etape
- alors() - Method in class com.tngtech.jgiven.lang.fr.SimpleTestDeScenarioBase
- alors() - Method in class com.tngtech.jgiven.lang.fr.TestDeScenarioBase
- AmbiguousResolutionException - Exception in com.tngtech.jgiven.exception
-
Thrown when a field cannot be uniquely resolved by the name or type.
- AmbiguousResolutionException(String) - Constructor for exception com.tngtech.jgiven.exception.AmbiguousResolutionException
- analyze(ReportModel) - Method in class com.tngtech.jgiven.report.analysis.CaseArgumentAnalyser
- analyze(ScenarioModel) - Method in class com.tngtech.jgiven.report.analysis.CaseArgumentAnalyser
- analyze(ScenarioModel) - Method in class com.tngtech.jgiven.report.analysis.CaseDifferenceAnalyzer
- and() - Method in class com.tngtech.jgiven.Stage
- angenommen() - Method in class com.tngtech.jgiven.lang.de.EinfacheSzenarioTestBasis
- angenommen() - Method in class com.tngtech.jgiven.lang.de.Stufe
- angenommen() - Method in class com.tngtech.jgiven.lang.de.SzenarioTestBasis
- AnnotationArgumentFormatter<T extends Annotation> - Interface in com.tngtech.jgiven.format
-
Interface for defining a formatter for a custom annotation using the
AnnotationFormat
annotation. - AnnotationBasedFormatter(AnnotationArgumentFormatter, Annotation) - Constructor for class com.tngtech.jgiven.report.model.StepFormatter.AnnotationBasedFormatter
- AnnotationFormat - Annotation Interface in com.tngtech.jgiven.annotation
-
Allows arguments of step methods to be formatted with an
AnnotationArgumentFormatter
. - appendWord(CharSequence) - Method in class com.tngtech.jgiven.report.model.Word
- application(String) - Static method in class com.tngtech.jgiven.attachment.MediaType
-
Creates a binary application media type with the given subtype.
- APPLICATION - Enum constant in enum class com.tngtech.jgiven.attachment.MediaType.Type
- APPLICATION_XML_UTF_8 - Static variable in class com.tngtech.jgiven.attachment.MediaType
-
application/xml
- applicationUtf8(String) - Static method in class com.tngtech.jgiven.attachment.MediaType
-
Creates a textual application media type with the given subtype and UTF-8 encoding
- apply(File) - Method in class com.tngtech.jgiven.report.json.ScenarioJsonReader
- apply(String) - Method in interface com.tngtech.jgiven.report.config.converter.StringConverter
- apply(String) - Method in class com.tngtech.jgiven.report.config.converter.ToBoolean
- apply(String) - Method in class com.tngtech.jgiven.report.config.converter.ToFile
- apply(String) - Method in class com.tngtech.jgiven.report.config.converter.ToFormat
- apply(String) - Method in class com.tngtech.jgiven.report.config.converter.ToString
- apply(STAGE) - Method in interface com.tngtech.jgiven.StepFunction
- args() - Element in annotation interface com.tngtech.jgiven.annotation.Format
-
Optional arguments for the ArgumentFormatter.
- ArgumentFormatter<T> - Interface in com.tngtech.jgiven.format
-
Interface for defining custom argument formatter using the
Format
annotation. - ArgumentFormatting(F, String...) - Constructor for class com.tngtech.jgiven.report.model.StepFormatter.ArgumentFormatting
- ArgumentInfo - Class in com.tngtech.jgiven.report.model
- ArgumentInfo() - Constructor for class com.tngtech.jgiven.report.model.ArgumentInfo
- arguments() - Method in class com.tngtech.jgiven.report.model.CasesTable.CaseRow
-
The argument values of the case.
- argWord(String, String, DataTable) - Static method in class com.tngtech.jgiven.report.model.Word
- argWord(String, String, String) - Static method in class com.tngtech.jgiven.report.model.Word
- as(As, Class<?>) - Method in interface com.tngtech.jgiven.annotation.AsProvider
-
Provide the representation for a scenario class.
- as(As, Method) - Method in interface com.tngtech.jgiven.annotation.AsProvider
-
Provide the representation for a stage method or scenario.
- as(String, List<String>, List<?>) - Method in interface com.tngtech.jgiven.annotation.CaseAsProvider
-
Provides the description of a single scenario case depending on the test parameters and optional additional arguments
- As - Annotation Interface in com.tngtech.jgiven.annotation
-
This annotation can be used to override the default representation for the items it was annotated with in the report.
- ASCIIDOC - Enum constant in enum class com.tngtech.jgiven.report.ReportGenerator.Format
- AsciiDocReportConfig - Class in com.tngtech.jgiven.report.asciidoc
-
Configuration for the AsciiDoc report.
- AsciiDocReportConfig() - Constructor for class com.tngtech.jgiven.report.asciidoc.AsciiDocReportConfig
- AsciiDocReportConfig(String...) - Constructor for class com.tngtech.jgiven.report.asciidoc.AsciiDocReportConfig
- AsciiDocReportGenerator - Class in com.tngtech.jgiven.report.asciidoc
-
This reporter provides the functionality for reading/writing a report in AsciiDoc format.
- AsciiDocReportGenerator() - Constructor for class com.tngtech.jgiven.report.asciidoc.AsciiDocReportGenerator
- AsProvider - Interface in com.tngtech.jgiven.annotation
-
Provides a representation of a stage method, scenario or scenario class.
- asString() - Method in class com.tngtech.jgiven.attachment.MediaType
- Attachment - Class in com.tngtech.jgiven.attachment
-
Represents an attachment of a step.
- Attachment(String, MediaType) - Constructor for class com.tngtech.jgiven.attachment.Attachment
-
Convenience constructor, where title is set to
null
- Attachment(String, MediaType, String) - Constructor for class com.tngtech.jgiven.attachment.Attachment
-
Creates a new instance of this Attachment
- AttachmentModel - Class in com.tngtech.jgiven.report.model
- AttachmentModel() - Constructor for class com.tngtech.jgiven.report.model.AttachmentModel
- audio(String) - Static method in class com.tngtech.jgiven.attachment.MediaType
-
Creates a binary audio media type with the given subtype.
- AUDIO - Enum constant in enum class com.tngtech.jgiven.attachment.MediaType.Type
- AUTO - Enum constant in enum class com.tngtech.jgiven.annotation.ScenarioState.Resolution
- AUTO - Enum constant in enum class com.tngtech.jgiven.config.ConfigValue
- avec() - Method in class com.tngtech.jgiven.lang.fr.Etape
B
- BeforeScenario - Annotation Interface in com.tngtech.jgiven.annotation
-
Marks methods to be executed before the whole Scenario has been executed.
- BeforeStage - Annotation Interface in com.tngtech.jgiven.annotation
-
Marks methods to be executed before a stage is executed, i.e.
- binary(MediaType.Type, String) - Static method in class com.tngtech.jgiven.attachment.MediaType
-
Creates a binary media type with the given type and subtype
- BooleanFormatter - Class in com.tngtech.jgiven.format
-
General formatter to format boolean values.
- BooleanFormatter() - Constructor for class com.tngtech.jgiven.format.BooleanFormatter
- BOTH - Enum constant in enum class com.tngtech.jgiven.annotation.Table.HeaderType
-
Treat both, the first row and the first column as headers
- BRACES - Enum constant in enum class com.tngtech.jgiven.annotation.POJOFormat.BracketsEnum
- brackets() - Element in annotation interface com.tngtech.jgiven.annotation.POJOFormat
-
Specify the opening/closing brackets pair to set POJO string representation apart of its parent (step) string representation.
- build() - Method in class com.tngtech.jgiven.config.TagConfiguration.Builder
- build() - Method in class com.tngtech.jgiven.report.config.CommandLineOptionBuilder
- build() - Method in class com.tngtech.jgiven.report.config.ConfigOptionBuilder
- builder(Class<? extends Annotation>) - Static method in class com.tngtech.jgiven.config.TagConfiguration
- buildFormattedWords() - Method in class com.tngtech.jgiven.report.model.StepFormatter
- buildFormattedWordsIgnoringExtraArguments() - Method in class com.tngtech.jgiven.report.model.StepFormatter
- but() - Method in class com.tngtech.jgiven.Stage
C
- CanWire - Interface in com.tngtech.jgiven.integration
- CaseArgumentAnalyser - Class in com.tngtech.jgiven.report.analysis
-
Analyzes a report model and tries to infer which step method arguments match to which case argument.
- CaseArgumentAnalyser() - Constructor for class com.tngtech.jgiven.report.analysis.CaseArgumentAnalyser
- CaseAs - Annotation Interface in com.tngtech.jgiven.annotation
-
Use to define a description provider for scenario cases.
- CaseAsProvider - Interface in com.tngtech.jgiven.annotation
-
Provides the description of a scenario case.
- CaseDifferenceAnalyzer - Class in com.tngtech.jgiven.report.analysis
- CaseDifferenceAnalyzer() - Constructor for class com.tngtech.jgiven.report.analysis.CaseDifferenceAnalyzer
- CaseRow(int, String, List<String>, ExecutionStatus, long, String, List<String>) - Constructor for class com.tngtech.jgiven.report.model.CasesTable.CaseRow
-
Create a new row representing a single ScenarioCaseModel.
- CasesTable - Class in com.tngtech.jgiven.report.model
-
Represents multiple scenario cases as a table structure for simpler reporting.
- CasesTable(List<String>, boolean, List<CasesTable.CaseRow>) - Constructor for class com.tngtech.jgiven.report.model.CasesTable
-
Create a new CasesTable from its parts.
- CasesTable.CaseRow - Class in com.tngtech.jgiven.report.model
-
Represents one case of a scenario.
- CasesTableCalculator - Class in com.tngtech.jgiven.report.model
-
Calculates a table representation for all cases of a scenario.
- CasesTableCalculator() - Constructor for class com.tngtech.jgiven.report.model.CasesTableCalculator
- CenarioTesteBase<DADO,
QUANDO, ENTAO> - Class in com.tngtech.jgiven.lang.pt - CenarioTesteBase() - Constructor for class com.tngtech.jgiven.lang.pt.CenarioTesteBase
- ChainedFormatting(ObjectFormatter<T>) - Constructor for class com.tngtech.jgiven.report.model.StepFormatter.ChainedFormatting
- CHEVRONS - Enum constant in enum class com.tngtech.jgiven.annotation.POJOFormat.BracketsEnum
- clearCases() - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- collectCases(ScenarioModel) - Method in class com.tngtech.jgiven.report.model.CasesTableCalculator
-
Collect cases form this scenario.
- color() - Element in annotation interface com.tngtech.jgiven.annotation.IsTag
-
A color that should be used in reports for this tag.
- color(String) - Method in class com.tngtech.jgiven.config.TagConfiguration.Builder
- columnTitles() - Element in annotation interface com.tngtech.jgiven.annotation.Table
-
Explicitly specifies column titles of table header.
- com() - Method in class com.tngtech.jgiven.lang.pt.Etapa
- com.tngtech.jgiven - package com.tngtech.jgiven
- com.tngtech.jgiven.annotation - package com.tngtech.jgiven.annotation
- com.tngtech.jgiven.attachment - package com.tngtech.jgiven.attachment
- com.tngtech.jgiven.base - package com.tngtech.jgiven.base
- com.tngtech.jgiven.config - package com.tngtech.jgiven.config
- com.tngtech.jgiven.exception - package com.tngtech.jgiven.exception
- com.tngtech.jgiven.format - package com.tngtech.jgiven.format
- com.tngtech.jgiven.format.table - package com.tngtech.jgiven.format.table
- com.tngtech.jgiven.integration - package com.tngtech.jgiven.integration
- com.tngtech.jgiven.lang.de - package com.tngtech.jgiven.lang.de
- com.tngtech.jgiven.lang.es - package com.tngtech.jgiven.lang.es
- com.tngtech.jgiven.lang.fr - package com.tngtech.jgiven.lang.fr
- com.tngtech.jgiven.lang.pt - package com.tngtech.jgiven.lang.pt
- com.tngtech.jgiven.report - package com.tngtech.jgiven.report
- com.tngtech.jgiven.report.analysis - package com.tngtech.jgiven.report.analysis
- com.tngtech.jgiven.report.asciidoc - package com.tngtech.jgiven.report.asciidoc
- com.tngtech.jgiven.report.config - package com.tngtech.jgiven.report.config
- com.tngtech.jgiven.report.config.converter - package com.tngtech.jgiven.report.config.converter
- com.tngtech.jgiven.report.json - package com.tngtech.jgiven.report.json
- com.tngtech.jgiven.report.model - package com.tngtech.jgiven.report.model
- com.tngtech.jgiven.report.text - package com.tngtech.jgiven.report.text
- comentario(String) - Method in class com.tngtech.jgiven.lang.es.Fase
- comentario(String) - Method in class com.tngtech.jgiven.lang.pt.Etapa
- CommandLineOption - Class in com.tngtech.jgiven.report.config
-
Defines a command line interface for use in
ConfigOption
with automatic help description generation used byConfigOptionParser.printUsageAndExit(List)
Instantiation throughCommandLineOptionBuilder
- CommandLineOption() - Constructor for class com.tngtech.jgiven.report.config.CommandLineOption
- CommandLineOptionBuilder - Class in com.tngtech.jgiven.report.config
-
An easier interface to instantiate
CommandLineOption
for use inConfigOption
- CommandLineOptionBuilder(String) - Constructor for class com.tngtech.jgiven.report.config.CommandLineOptionBuilder
- comment(String) - Method in class com.tngtech.jgiven.Stage
- commentaire(String) - Method in class com.tngtech.jgiven.lang.fr.Etape
- completeReportModel - Variable in class com.tngtech.jgiven.report.AbstractReportGenerator
- CompleteReportModel - Class in com.tngtech.jgiven.report.model
-
Represents the complete report model of all report files.
- CompleteReportModel() - Constructor for class com.tngtech.jgiven.report.model.CompleteReportModel
- con() - Method in class com.tngtech.jgiven.lang.es.Fase
- config - Variable in class com.tngtech.jgiven.report.AbstractReportGenerator
- ConfigOption - Class in com.tngtech.jgiven.report.config
-
Defines a configuration for the report which can be from the command line, property or the environment Instantiated with
ConfigOptionBuilder
For use inAbstractReportConfig.additionalConfigOptions(List)
and the generated object map inAbstractReportConfig(String...)
- ConfigOption() - Constructor for class com.tngtech.jgiven.report.config.ConfigOption
- ConfigOptionBuilder - Class in com.tngtech.jgiven.report.config
-
An easier interface to create
ConfigOption
for use withAbstractReportGenerator
- ConfigOptionBuilder(String) - Constructor for class com.tngtech.jgiven.report.config.ConfigOptionBuilder
- ConfigOptionParser - Class in com.tngtech.jgiven.report.config
- ConfigOptionParser() - Constructor for class com.tngtech.jgiven.report.config.ConfigOptionParser
- ConfigurationUtil - Class in com.tngtech.jgiven.config
- ConfigurationUtil() - Constructor for class com.tngtech.jgiven.config.ConfigurationUtil
- configure() - Method in class com.tngtech.jgiven.config.AbstractJGivenConfiguration
- configure() - Method in class com.tngtech.jgiven.config.DefaultConfiguration
- configureTag(Class<? extends Annotation>) - Method in class com.tngtech.jgiven.config.AbstractJGivenConfiguration
-
Configures the given annotation as a tag.
- ConfigValue - Enum Class in com.tngtech.jgiven.config
-
Represents a configuration value
- convertCaseFooterBlock(String, List<String>) - Method in interface com.tngtech.jgiven.report.ReportBlockConverter
-
Is invoked if the case failed with an exception.
- convertCaseHeaderBlock(int, ExecutionStatus, long, String) - Method in interface com.tngtech.jgiven.report.ReportBlockConverter
-
Convert scenario case number and parameters into case header.
- convertCasesTableBlock(CasesTable) - Method in interface com.tngtech.jgiven.report.ReportBlockConverter
-
Is invoked at the end of a scenario, when the scenario has multiple case and a data table.
- convertFeatureHeaderBlock(String, ReportStatistics, String) - Method in interface com.tngtech.jgiven.report.ReportBlockConverter
-
Convert feature name and execution statistics into feature header.
- convertFirstStepBlock(int, List<Word>, StepStatus, long, String, boolean, String) - Method in interface com.tngtech.jgiven.report.ReportBlockConverter
-
Convert the words that make up the first step into a block.
- convertScenarioFooterBlock(ExecutionStatus) - Method in interface com.tngtech.jgiven.report.ReportBlockConverter
-
Is invoked at the end of a scenario.
- convertScenarioHeaderBlock(String, ExecutionStatus, long, List<Tag>, String) - Method in interface com.tngtech.jgiven.report.ReportBlockConverter
-
Convert scenario name and more meta information into scenario header.
- convertStatisticsBlock(ListMultimap<String, ReportStatistics>, ReportStatistics) - Method in interface com.tngtech.jgiven.report.ReportBlockConverter
-
Convert a set of execution statistics into a statistics table.
- convertStepBlock(int, List<Word>, StepStatus, long, String, boolean) - Method in interface com.tngtech.jgiven.report.ReportBlockConverter
-
Convert the words that make up a step into a block.
- copy() - Method in class com.tngtech.jgiven.report.model.Tag
- create(FormatterConfiguration, ObjectFormatter<?>) - Method in class com.tngtech.jgiven.format.table.DefaultTableFormatter.Factory
- create(FormatterConfiguration, ObjectFormatter<?>) - Method in interface com.tngtech.jgiven.format.table.TableFormatterFactory
-
Creates a
TableFormatter
- create(Class<?>, String, Table, Annotation[], FormatterConfiguration, ObjectFormatter<?>) - Method in class com.tngtech.jgiven.format.table.DefaultRowFormatterFactory
- create(Class<?>, String, Table, Annotation[], FormatterConfiguration, ObjectFormatter<?>) - Method in class com.tngtech.jgiven.format.table.FieldBasedRowFormatter.Factory
- create(Class<?>, String, Table, Annotation[], FormatterConfiguration, ObjectFormatter<?>) - Method in class com.tngtech.jgiven.format.table.PlainRowFormatter.Factory
- create(Class<?>, String, Table, Annotation[], FormatterConfiguration, ObjectFormatter<?>) - Method in interface com.tngtech.jgiven.format.table.RowFormatterFactory
-
Creates a new
RowFormatter
instance. - createNewScenario() - Method in class com.tngtech.jgiven.base.ScenarioTestBase
- createReportConfig(String...) - Method in class com.tngtech.jgiven.report.AbstractReportGenerator
- createReportConfig(String...) - Method in class com.tngtech.jgiven.report.asciidoc.AsciiDocReportGenerator
- createReportConfig(String...) - Method in class com.tngtech.jgiven.report.text.PlainTextReportGenerator
- createScenario() - Method in class com.tngtech.jgiven.base.DualScenarioTestBase
- createScenario() - Method in class com.tngtech.jgiven.base.ScenarioTestBase
- createScenario() - Method in class com.tngtech.jgiven.base.SimpleScenarioTestBase
- cssClass() - Element in annotation interface com.tngtech.jgiven.annotation.IsTag
-
Sets a CSS class that should be used in the HTML report for this tag.
- cssClass(String) - Method in class com.tngtech.jgiven.config.TagConfiguration.Builder
- cuando() - Method in class com.tngtech.jgiven.lang.es.EscenarioTestBase
- cuando() - Method in class com.tngtech.jgiven.lang.es.Fase
- cuando() - Method in class com.tngtech.jgiven.lang.es.SimpleEscenarioTestBase
- currentCaseModel - Variable in class com.tngtech.jgiven.report.text.PlainTextScenarioWriter
- CurrentScenario - Interface in com.tngtech.jgiven
-
This interface can be injected into a stage using the
ScenarioState
annotation. - currentScenarioModel - Variable in class com.tngtech.jgiven.report.text.PlainTextScenarioWriter
- CurrentStep - Interface in com.tngtech.jgiven
-
This interface can be injected into a stage by using the
ScenarioState
annotation.
D
- dada() - Method in class com.tngtech.jgiven.lang.es.EscenarioTestBase
- dada() - Method in class com.tngtech.jgiven.lang.es.Fase
- dada() - Method in class com.tngtech.jgiven.lang.es.SimpleEscenarioTestBase
- dada() - Method in class com.tngtech.jgiven.lang.pt.CenarioTesteBase
- dada() - Method in class com.tngtech.jgiven.lang.pt.Etapa
- dada() - Method in class com.tngtech.jgiven.lang.pt.SimplesCenarioTesteBase
- dado() - Method in class com.tngtech.jgiven.lang.es.EscenarioTestBase
- dado() - Method in class com.tngtech.jgiven.lang.es.Fase
- dado() - Method in class com.tngtech.jgiven.lang.es.SimpleEscenarioTestBase
- dado() - Method in class com.tngtech.jgiven.lang.pt.CenarioTesteBase
- dado() - Method in class com.tngtech.jgiven.lang.pt.Etapa
- dado() - Method in class com.tngtech.jgiven.lang.pt.SimplesCenarioTesteBase
- dann() - Method in class com.tngtech.jgiven.lang.de.EinfacheSzenarioTestBasis
- dann() - Method in class com.tngtech.jgiven.lang.de.Stufe
- dann() - Method in class com.tngtech.jgiven.lang.de.SzenarioTestBasis
- DataTable - Class in com.tngtech.jgiven.report.model
-
Represents a data table argument.
- DataTable(Table.HeaderType, List<List<String>>) - Constructor for class com.tngtech.jgiven.report.model.DataTable
- DataTablePlainTextScenarioWriter - Class in com.tngtech.jgiven.report.text
- DataTablePlainTextScenarioWriter(PrintWriter, boolean) - Constructor for class com.tngtech.jgiven.report.text.DataTablePlainTextScenarioWriter
- DataTables - Class in com.tngtech.jgiven
-
A utility class to create data tables.
- DataTables() - Constructor for class com.tngtech.jgiven.DataTables
- DateFormatter - Class in com.tngtech.jgiven.format
-
General formatter to format
Date
values. - DateFormatter() - Constructor for class com.tngtech.jgiven.format.DateFormatter
- DEFAULT_NUMBERED_HEADER - Static variable in class com.tngtech.jgiven.format.table.DefaultTableFormatter
- DefaultConfiguration - Class in com.tngtech.jgiven.config
- DefaultConfiguration() - Constructor for class com.tngtech.jgiven.config.DefaultConfiguration
- DefaultFormatter<T> - Class in com.tngtech.jgiven.format
-
A default formatter that merely use
String.valueOf(Object)
, except for arrays whereArrays.deepToString(Object[])
is used. - DefaultFormatter() - Constructor for class com.tngtech.jgiven.format.DefaultFormatter
- DefaultObjectFormatter - Class in com.tngtech.jgiven.format
-
A default formatter for
Object
types - DefaultObjectFormatter() - Constructor for class com.tngtech.jgiven.format.DefaultObjectFormatter
- DefaultRowFormatterFactory - Class in com.tngtech.jgiven.format.table
-
Default RowFormatterFactory that evaluates the
Table.objectFormatting()
attribute to create a RowFormatter. - DefaultRowFormatterFactory() - Constructor for class com.tngtech.jgiven.format.table.DefaultRowFormatterFactory
- DefaultTableFormatter - Class in com.tngtech.jgiven.format.table
-
The default implementation to format a table argument
- DefaultTableFormatter(FormatterConfiguration, ObjectFormatter<?>) - Constructor for class com.tngtech.jgiven.format.table.DefaultTableFormatter
- DefaultTableFormatter.Factory - Class in com.tngtech.jgiven.format.table
- defaultValue(String) - Method in class com.tngtech.jgiven.config.TagConfiguration.Builder
- description() - Element in annotation interface com.tngtech.jgiven.annotation.IsTag
-
An optional description of the tag that will appear in the generated report.
- description() - Method in class com.tngtech.jgiven.report.model.CasesTable.CaseRow
-
The case description.
- description(String) - Method in class com.tngtech.jgiven.config.TagConfiguration.Builder
- Description - Annotation Interface in com.tngtech.jgiven.annotation
-
This annotation can be used to provide a description for a test class.
- descriptionGenerator() - Element in annotation interface com.tngtech.jgiven.annotation.IsTag
-
An optional description generator that is used to dynamically generate the description depending on the concrete value of an annotation.
- descriptionGenerator(Class<? extends TagDescriptionGenerator>) - Method in class com.tngtech.jgiven.config.TagConfiguration.Builder
- DoNotIntercept - Annotation Interface in com.tngtech.jgiven.annotation
-
Methods of stages classes annotated with this annotation will not be intercepted by JGiven.
- DOUBLE_QUOTE - Enum constant in enum class com.tngtech.jgiven.annotation.POJOFormat.BracketsEnum
- DualScenarioTestBase<GIVEN_WHEN,
THEN> - Class in com.tngtech.jgiven.base -
ScenarioTest that only takes two type parameters, where the first is used for combined GIVEN and WHEN and the second is used for THEN.
- DualScenarioTestBase() - Constructor for class com.tngtech.jgiven.base.DualScenarioTestBase
- durationInNanos - Variable in class com.tngtech.jgiven.report.model.ReportStatistics
- durationInNanos() - Method in class com.tngtech.jgiven.report.model.CasesTable.CaseRow
-
The duration of the case.
E
- e() - Method in class com.tngtech.jgiven.lang.pt.Etapa
- EinfacheSzenarioTestBasis<STUFE> - Class in com.tngtech.jgiven.lang.de
- EinfacheSzenarioTestBasis() - Constructor for class com.tngtech.jgiven.lang.de.EinfacheSzenarioTestBasis
- entao() - Method in class com.tngtech.jgiven.lang.pt.CenarioTesteBase
- entao() - Method in class com.tngtech.jgiven.lang.pt.Etapa
- entao() - Method in class com.tngtech.jgiven.lang.pt.SimplesCenarioTesteBase
- entonces() - Method in class com.tngtech.jgiven.lang.es.EscenarioTestBase
- entonces() - Method in class com.tngtech.jgiven.lang.es.Fase
- entonces() - Method in class com.tngtech.jgiven.lang.es.SimpleEscenarioTestBase
- equals(Object) - Method in class com.tngtech.jgiven.report.model.ArgumentInfo
- equals(Object) - Method in class com.tngtech.jgiven.report.model.DataTable
- equals(Object) - Method in class com.tngtech.jgiven.report.model.NamedArgument
- equals(Object) - Method in class com.tngtech.jgiven.report.model.Tag
- equals(Object) - Method in class com.tngtech.jgiven.report.model.Word
- errorMessage() - Method in class com.tngtech.jgiven.report.model.CasesTable.CaseRow
-
The error message of the case if any.
- EscenarioTestBase<DADO,
CUANDO, ENTONCES> - Class in com.tngtech.jgiven.lang.es - EscenarioTestBase() - Constructor for class com.tngtech.jgiven.lang.es.EscenarioTestBase
- et() - Method in class com.tngtech.jgiven.lang.fr.Etape
- et_que() - Method in class com.tngtech.jgiven.lang.fr.Etape
- etant_donne() - Method in class com.tngtech.jgiven.lang.fr.Etape
- etant_donne() - Method in class com.tngtech.jgiven.lang.fr.SimpleTestDeScenarioBase
- etant_donne() - Method in class com.tngtech.jgiven.lang.fr.TestDeScenarioBase
- etant_donne_que() - Method in class com.tngtech.jgiven.lang.fr.Etape
- etant_donne_que() - Method in class com.tngtech.jgiven.lang.fr.SimpleTestDeScenarioBase
- etant_donne_que() - Method in class com.tngtech.jgiven.lang.fr.TestDeScenarioBase
- etant_donnee() - Method in class com.tngtech.jgiven.lang.fr.Etape
- etant_donnee() - Method in class com.tngtech.jgiven.lang.fr.SimpleTestDeScenarioBase
- etant_donnee() - Method in class com.tngtech.jgiven.lang.fr.TestDeScenarioBase
- etant_donnee_que() - Method in class com.tngtech.jgiven.lang.fr.Etape
- etant_donnee_que() - Method in class com.tngtech.jgiven.lang.fr.SimpleTestDeScenarioBase
- etant_donnee_que() - Method in class com.tngtech.jgiven.lang.fr.TestDeScenarioBase
- Etapa<SELF extends Etapa<?>> - Class in com.tngtech.jgiven.lang.pt
-
Uma versão em português da classe
Stage
. - Etapa() - Constructor for class com.tngtech.jgiven.lang.pt.Etapa
- Etape<SELF extends Etape<?>> - Class in com.tngtech.jgiven.lang.fr
-
Une version française de la classe
Stage
. - Etape() - Constructor for class com.tngtech.jgiven.lang.fr.Etape
- excludeFields() - Element in annotation interface com.tngtech.jgiven.annotation.POJOFormat
-
Specifies which fields should be excluded in the report.
- excludeFields() - Element in annotation interface com.tngtech.jgiven.annotation.Table
-
Specifies which fields should be excluded in the report.
- executeSteps() - Element in annotation interface com.tngtech.jgiven.annotation.Pending
-
Instead of only reporting pending steps, the steps are actually executed.
- ExecutionStatus - Enum Class in com.tngtech.jgiven.report.model
- ExpectedScenarioState - Annotation Interface in com.tngtech.jgiven.annotation
-
Marks fields to be expected by a scenario stage.
- explodeArray() - Element in annotation interface com.tngtech.jgiven.annotation.IsTag
-
If the annotation has a value and the value is an array, whether or not to explode that array to multiple tags or not.
- explodeArray(boolean) - Method in class com.tngtech.jgiven.config.TagConfiguration.Builder
- ExtendedDescription - Annotation Interface in com.tngtech.jgiven.annotation
-
This annotation can be used to define an extended description for a step method or a test method.
F
- Factory() - Constructor for class com.tngtech.jgiven.format.table.DefaultTableFormatter.Factory
- Factory() - Constructor for class com.tngtech.jgiven.format.table.FieldBasedRowFormatter.Factory
- Factory() - Constructor for class com.tngtech.jgiven.format.table.PlainRowFormatter.Factory
- FAILED - Enum constant in enum class com.tngtech.jgiven.report.model.ExecutionStatus
- FAILED - Enum constant in enum class com.tngtech.jgiven.report.model.InvocationMode
- FAILED - Enum constant in enum class com.tngtech.jgiven.report.model.StepStatus
- failedScenarios - Variable in class com.tngtech.jgiven.report.model.CompleteReportModel
- failIfPass() - Element in annotation interface com.tngtech.jgiven.annotation.Pending
-
If no step fails during the execution of the test, the test will fail.
- FailIfPassedException - Exception in com.tngtech.jgiven.exception
- FailIfPassedException() - Constructor for exception com.tngtech.jgiven.exception.FailIfPassedException
- FALSE - Enum constant in enum class com.tngtech.jgiven.config.ConfigValue
- Fase<SELF extends Fase<?>> - Class in com.tngtech.jgiven.lang.es
-
Una versión en español de la clase
Stage
. - Fase() - Constructor for class com.tngtech.jgiven.lang.es.Fase
- FieldBasedRowFormatter - Class in com.tngtech.jgiven.format.table
-
Default implementation of the
RowFormatter
that uses the fields of an object as columns of the table - FieldBasedRowFormatter(Class<?>, String, Table, Annotation[]) - Constructor for class com.tngtech.jgiven.format.table.FieldBasedRowFormatter
- FieldBasedRowFormatter.Factory - Class in com.tngtech.jgiven.format.table
-
Factory for creating instances of
FieldBasedRowFormatter
- fieldFormats() - Element in annotation interface com.tngtech.jgiven.annotation.POJOFormat
-
Specify an array of
NamedFormat
to use when formatting POJOs fields. - fieldFormatsAnnotation() - Element in annotation interface com.tngtech.jgiven.annotation.POJOFormat
-
Specify a custom
NamedFormats
annotation - FIELDS - Enum constant in enum class com.tngtech.jgiven.annotation.Table.ObjectFormatting
-
Each field of the object becomes a column in the table
- fieldSeparator() - Element in annotation interface com.tngtech.jgiven.annotation.POJOFormat
-
Specify a field separator
- fieldsFormat() - Element in annotation interface com.tngtech.jgiven.annotation.Table
-
Specify an array of
NamedFormat
to use when formatting POJOs fields. - fieldsFormatSetAnnotation() - Element in annotation interface com.tngtech.jgiven.annotation.Table
-
Specify a custom
NamedFormats
annotation - file - Variable in exception com.tngtech.jgiven.report.json.ScenarioJsonReader.JsonReaderException
- file() - Method in class com.tngtech.jgiven.report.model.ReportModelFile
- FillerWord - Annotation Interface in com.tngtech.jgiven.annotation
-
Marks a method which will be used as a preamble to the next non-filler stage method.
- findScenarioModel(String) - Method in class com.tngtech.jgiven.report.model.ReportModel
- flush() - Method in class com.tngtech.jgiven.report.text.PlainTextReporter
- format() - Element in annotation interface com.tngtech.jgiven.annotation.NamedFormat
-
Specify an inline
Format
- format(Boolean, String...) - Method in class com.tngtech.jgiven.format.BooleanFormatter
- format(Boolean, String...) - Method in class com.tngtech.jgiven.format.NotFormatter
- format(Object) - Method in class com.tngtech.jgiven.report.model.StepFormatter.TableFormatting
- format(Object, Formatf) - Method in class com.tngtech.jgiven.format.PrintfAnnotationFormatter
- format(Object, POJOFormat) - Method in class com.tngtech.jgiven.format.POJOAnnotationFormatter
- format(Object, Table, String, Annotation...) - Method in class com.tngtech.jgiven.format.table.DefaultTableFormatter
- format(Object, Table, String, Annotation...) - Method in interface com.tngtech.jgiven.format.table.TableFormatter
-
Generates a
DataTable
from a given table argument - format(Object, String...) - Method in class com.tngtech.jgiven.format.PrintfFormatter
- format(Object, String...) - Method in class com.tngtech.jgiven.report.model.StepFormatter.AnnotationBasedFormatter
- format(Object, T) - Method in interface com.tngtech.jgiven.format.AnnotationArgumentFormatter
-
Format a single argument by taking the given annotation into account.
- format(Date, String...) - Method in class com.tngtech.jgiven.format.DateFormatter
-
A
SimpleDateFormat
pattern is expected as first argument.
An optional second argument can be set to specify a locale as an ISO 639 language code. - format(T) - Method in class com.tngtech.jgiven.format.DefaultFormatter
- format(T) - Method in interface com.tngtech.jgiven.format.ObjectFormatter
- format(T) - Method in class com.tngtech.jgiven.report.model.StepFormatter.ArgumentFormatting
- format(T) - Method in class com.tngtech.jgiven.report.model.StepFormatter.ChainedFormatting
- format(T) - Method in class com.tngtech.jgiven.report.model.StepFormatter.Formatting
- format(T) - Method in class com.tngtech.jgiven.report.model.StepFormatter.TypeBasedFormatting
- format(T, Annotation...) - Method in class com.tngtech.jgiven.format.DefaultFormatter
- format(T, Annotation...) - Method in interface com.tngtech.jgiven.format.Formatter
-
Formats a step method argument.
- format(T, String...) - Method in interface com.tngtech.jgiven.format.ArgumentFormatter
-
Format a single argument by taking optional formatter arguments into account.
- format(T, String...) - Method in class com.tngtech.jgiven.format.DefaultFormatter
- Format - Annotation Interface in com.tngtech.jgiven.annotation
-
Allows arguments of step methods to be formatted with an ArgumentFormatter.
- formatAnnotation() - Element in annotation interface com.tngtech.jgiven.annotation.NamedFormat
-
Specify a custom format annotation
- Formatf - Annotation Interface in com.tngtech.jgiven.annotation
-
A special format annotation that uses the formatting known from the String.format method.
- formatName() - Method in enum class com.tngtech.jgiven.report.ReportGenerator.Format
- formatRow(Object) - Method in class com.tngtech.jgiven.format.table.FieldBasedRowFormatter
- formatRow(Object) - Method in class com.tngtech.jgiven.format.table.PlainRowFormatter
- formatRow(Object) - Method in class com.tngtech.jgiven.format.table.RowFormatter
-
Generates a single row of the data table for the given object.
- formatTable(Object) - Method in class com.tngtech.jgiven.report.model.StepFormatter.TableFormatting
- formatter - Variable in class com.tngtech.jgiven.report.model.StepFormatter.Formatting
- formatter() - Element in annotation interface com.tngtech.jgiven.annotation.Table
-
The formatter to use to translate the parameter object to a table.
- Formatter<T> - Interface in com.tngtech.jgiven.format
-
Interface for defining a global argument formatter.
- FormatterConfiguration - Interface in com.tngtech.jgiven.config
- formatValues() - Element in annotation interface com.tngtech.jgiven.annotation.CaseAs
-
Whether or not the arguments should be formatted to string using JGiven formatter.
- fromBase64(String, MediaType) - Static method in class com.tngtech.jgiven.attachment.Attachment
-
Equivalent to
Attachment(String, MediaType)
- fromBinaryBytes(byte[], MediaType) - Static method in class com.tngtech.jgiven.attachment.Attachment
-
Creates an attachment from a given array of bytes.
- fromBinaryFile(File, MediaType) - Static method in class com.tngtech.jgiven.attachment.Attachment
-
Creates an attachment from the given binary file
file
. - fromBinaryInputStream(InputStream, MediaType) - Static method in class com.tngtech.jgiven.attachment.Attachment
-
Creates an attachment from a binary input stream.
- fromString(String) - Static method in enum class com.tngtech.jgiven.attachment.MediaType.Type
-
Get the type from a given string
- fromString(String) - Static method in enum class com.tngtech.jgiven.config.ConfigValue
- fromStringOrNull(String) - Static method in enum class com.tngtech.jgiven.report.ReportGenerator.Format
- fromText(String, MediaType) - Static method in class com.tngtech.jgiven.attachment.Attachment
-
Equivalent to
Attachment(String, MediaType)
- fromTextFile(File, MediaType) - Static method in class com.tngtech.jgiven.attachment.Attachment
-
Creates a non-binary attachment from the given file.
- fromTextInputStream(InputStream, MediaType) - Static method in class com.tngtech.jgiven.attachment.Attachment
-
Creates a non-binary attachment from the given file.
G
- gegeben() - Method in class com.tngtech.jgiven.lang.de.EinfacheSzenarioTestBasis
- gegeben() - Method in class com.tngtech.jgiven.lang.de.Stufe
- gegeben() - Method in class com.tngtech.jgiven.lang.de.SzenarioTestBasis
- generate() - Method in class com.tngtech.jgiven.report.AbstractReportGenerator
-
This implements the main functionality of the report generator, utilizing the information from the specialized
AbstractReportConfig
- generate() - Method in class com.tngtech.jgiven.report.asciidoc.AsciiDocReportGenerator
- generate() - Method in class com.tngtech.jgiven.report.text.PlainTextReportGenerator
- generate(String...) - Method in class com.tngtech.jgiven.report.ReportGenerator
-
Starts the respective report (default is HTML5)
- generate(List<ConfigOption>, String...) - Method in class com.tngtech.jgiven.report.config.ConfigOptionParser
-
Parses the configuration list and tries to create a mapping of the corresponding objects from the command line, properties or environment variables As long as the
StringConverter
are implemented with a null as fail and a working conversion the mapped objects are always in a correct state and castable to their representation - generateDescription(TagConfiguration, Annotation, Object) - Method in interface com.tngtech.jgiven.annotation.TagDescriptionGenerator
-
Implement this method to generate the description for the given annotation and its value.
- generateFromCommandLine(String...) - Method in class com.tngtech.jgiven.report.AbstractReportGenerator
- generateHref(TagConfiguration, Annotation, Object) - Method in interface com.tngtech.jgiven.annotation.TagHrefGenerator
-
Implement this method to generate the href for the given annotation and its value.
- generateHtml5Report() - Static method in class com.tngtech.jgiven.report.ReportGenerator
-
Searches the Html5ReportGenerator in Java path and instantiates the report
- generateWithConfig(AbstractReportConfig) - Method in class com.tngtech.jgiven.report.AbstractReportGenerator
- getAllReportModels() - Method in class com.tngtech.jgiven.report.model.CompleteReportModel
- getAllScenarios() - Method in class com.tngtech.jgiven.report.model.CompleteReportModel
- getAllTags() - Method in class com.tngtech.jgiven.report.model.CompleteReportModel
- getAnnotationFullType() - Method in class com.tngtech.jgiven.config.TagConfiguration
- getAnnotationType() - Method in class com.tngtech.jgiven.config.TagConfiguration
- getArgumentInfo() - Method in class com.tngtech.jgiven.report.model.Word
- getArgumentName() - Method in class com.tngtech.jgiven.report.model.ArgumentInfo
- getAsProvider() - Method in class com.tngtech.jgiven.config.AbstractJGivenConfiguration
- getAttachments() - Method in class com.tngtech.jgiven.report.model.StepModel
- getCase(int) - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- getCaseNr() - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- getCharset() - Method in class com.tngtech.jgiven.attachment.MediaType
- getClassName() - Method in class com.tngtech.jgiven.report.model.ReportModel
- getClassName() - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- getClosing() - Method in enum class com.tngtech.jgiven.annotation.POJOFormat.BracketsEnum
- getColor() - Method in class com.tngtech.jgiven.config.TagConfiguration
- getColor() - Method in class com.tngtech.jgiven.report.model.Tag
- getColumnCount() - Method in class com.tngtech.jgiven.report.model.DataTable
- getCommandLineOption() - Method in class com.tngtech.jgiven.report.config.ConfigOption
- getComment() - Method in class com.tngtech.jgiven.report.model.StepModel
- getCompleteSentence() - Method in class com.tngtech.jgiven.report.model.StepModel
- getConfiguration(Class<?>) - Static method in class com.tngtech.jgiven.config.ConfigurationUtil
- getContent() - Method in class com.tngtech.jgiven.attachment.Attachment
-
The content of the attachment represented as a string.
- getConverter() - Method in class com.tngtech.jgiven.report.config.ConfigOption
- getCssClass() - Method in class com.tngtech.jgiven.config.TagConfiguration
- getCssClass() - Method in class com.tngtech.jgiven.report.model.Tag
- getCssClassOrDefault() - Method in class com.tngtech.jgiven.report.model.Tag
- getData() - Method in class com.tngtech.jgiven.report.model.DataTable
- getDataTable() - Method in class com.tngtech.jgiven.report.model.ArgumentInfo
- getDefaultValue() - Method in class com.tngtech.jgiven.config.TagConfiguration
- getDelimiter() - Method in class com.tngtech.jgiven.report.config.CommandLineOption
- getDepth() - Method in class com.tngtech.jgiven.report.model.StepModel
- getDerivedArguments() - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- getDerivedParameters() - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- getDescription() - Method in class com.tngtech.jgiven.config.TagConfiguration
- getDescription() - Method in class com.tngtech.jgiven.report.config.ConfigOption
- getDescription() - Method in class com.tngtech.jgiven.report.model.ReportModel
- getDescription() - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- getDescription() - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- getDescription() - Method in class com.tngtech.jgiven.report.model.Tag
- getDescriptionGenerator() - Method in class com.tngtech.jgiven.config.TagConfiguration
- getDescriptionOrDefault(ScenarioCaseModel) - Method in class com.tngtech.jgiven.report.text.PlainTextScenarioWriter
- getDurationInNanos() - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- getDurationInNanos() - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- getDurationInNanos() - Method in class com.tngtech.jgiven.report.model.StepModel
- getEnhancedDescription() - Method in class com.tngtech.jgiven.report.config.ConfigOption
- getEnvString() - Method in class com.tngtech.jgiven.report.config.ConfigOption
- getErrorMessage() - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- getExcludeEmptyScenarios() - Method in class com.tngtech.jgiven.report.AbstractReportConfig
- getExecutionStatus() - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- getExecutionStatus() - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- getExplicitArguments() - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- getExplicitParameters() - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- getExtendedDescription() - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- getExtendedDescription() - Method in class com.tngtech.jgiven.report.model.StepModel
- getFailedScenarios() - Method in class com.tngtech.jgiven.report.model.CompleteReportModel
- getFailedScenarios() - Method in class com.tngtech.jgiven.report.model.ReportModel
- getFileName() - Method in class com.tngtech.jgiven.attachment.Attachment
-
An optional filename for the attachment.
- getFileName() - Method in class com.tngtech.jgiven.report.model.AttachmentModel
- getFirstStep() - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- getFirstStepModelOfLastScenario() - Method in class com.tngtech.jgiven.report.model.ReportModel
- getFormat(String...) - Static method in class com.tngtech.jgiven.report.config.ConfigOptionParser
-
Terminates with a help message if the parse is not successful
- getFormattedValue() - Method in class com.tngtech.jgiven.report.model.ArgumentInfo
- getFormattedValue() - Method in class com.tngtech.jgiven.report.model.Word
- getFormatter() - Method in class com.tngtech.jgiven.report.model.StepFormatter.Formatting
- getFormatter(Class<?>) - Method in class com.tngtech.jgiven.config.AbstractJGivenConfiguration
- getFormatter(Class<?>) - Method in interface com.tngtech.jgiven.config.FormatterConfiguration
- getFullType() - Method in class com.tngtech.jgiven.report.model.Tag
- getHeaderType() - Method in class com.tngtech.jgiven.report.model.DataTable
- getHref() - Method in class com.tngtech.jgiven.config.TagConfiguration
- getHref() - Method in class com.tngtech.jgiven.report.model.Tag
- getHrefGenerator() - Method in class com.tngtech.jgiven.config.TagConfiguration
- getLastScenarioModel() - Method in class com.tngtech.jgiven.report.model.ReportModel
- getLastWord() - Method in class com.tngtech.jgiven.report.model.StepModel
- getLongFlag() - Method in class com.tngtech.jgiven.report.config.CommandLineOption
- getLongName() - Method in class com.tngtech.jgiven.report.config.ConfigOption
- getMediaType() - Method in class com.tngtech.jgiven.attachment.Attachment
-
The type of the attachment.
- getMediaType() - Method in class com.tngtech.jgiven.report.model.AttachmentModel
- getName() - Method in class com.tngtech.jgiven.config.TagConfiguration
- getName() - Method in class com.tngtech.jgiven.report.model.ReportModel
- getName() - Method in class com.tngtech.jgiven.report.model.StepModel
- getName() - Method in class com.tngtech.jgiven.report.model.Tag
- getNestedSteps() - Method in class com.tngtech.jgiven.report.model.StepModel
- getOpening() - Method in enum class com.tngtech.jgiven.annotation.POJOFormat.BracketsEnum
- getPackageName() - Method in class com.tngtech.jgiven.report.model.ReportModel
- getParameterName() - Method in class com.tngtech.jgiven.report.model.ArgumentInfo
- getPendingScenarios() - Method in class com.tngtech.jgiven.report.model.CompleteReportModel
- getPendingScenarios() - Method in class com.tngtech.jgiven.report.model.ReportModel
- getPlaceholder() - Method in class com.tngtech.jgiven.report.config.CommandLineOption
- getPropertyString() - Method in class com.tngtech.jgiven.report.config.ConfigOption
- getReportModel() - Method in class com.tngtech.jgiven.report.AbstractReportConfig
- getRowCount() - Method in class com.tngtech.jgiven.report.model.DataTable
- getScenario() - Method in class com.tngtech.jgiven.base.ScenarioTestBase
- getScenarioCases() - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- getScenarios() - Method in class com.tngtech.jgiven.report.model.ReportModel
- getScenariosByTag(Tag) - Method in class com.tngtech.jgiven.report.model.CompleteReportModel
- getScenariosWithStatus(ExecutionStatus, ExecutionStatus...) - Method in class com.tngtech.jgiven.report.model.ReportModel
- getShortFlag() - Method in class com.tngtech.jgiven.report.config.CommandLineOption
- getShortName() - Method in class com.tngtech.jgiven.report.config.ConfigOption
- getShowDirectly() - Method in class com.tngtech.jgiven.attachment.Attachment
-
Whether this attachment is shown showDirectly or not
- getShownInNavigation() - Method in class com.tngtech.jgiven.report.model.Tag
- getSimpleClassName() - Method in class com.tngtech.jgiven.report.model.ReportModel
- getSourceDir() - Method in class com.tngtech.jgiven.report.AbstractReportConfig
- getStackTrace() - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- getStatistics(ReportModel) - Method in class com.tngtech.jgiven.report.model.StatisticsCalculator
- getStatistics(ReportModelFile) - Method in class com.tngtech.jgiven.report.model.CompleteReportModel
- getStatus() - Method in class com.tngtech.jgiven.report.model.StepModel
- getStep(int) - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- getSteps() - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- getStyle() - Method in class com.tngtech.jgiven.config.TagConfiguration
- getStyle() - Method in class com.tngtech.jgiven.report.model.Tag
- getSubType() - Method in class com.tngtech.jgiven.attachment.MediaType
-
The subtype of the Media Type.
- getTagConfiguration(Class<? extends Annotation>) - Method in class com.tngtech.jgiven.config.AbstractJGivenConfiguration
- getTagIdMap() - Method in class com.tngtech.jgiven.report.model.CompleteReportModel
- getTagIds() - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- getTagMap() - Method in class com.tngtech.jgiven.report.model.ReportModel
- getTags() - Method in class com.tngtech.jgiven.config.TagConfiguration
- getTags() - Method in class com.tngtech.jgiven.report.model.Tag
- getTagWithId(String) - Method in class com.tngtech.jgiven.report.model.ReportModel
- getTargetDir() - Method in class com.tngtech.jgiven.report.AbstractReportConfig
- getTestClassSuffixRegEx() - Method in class com.tngtech.jgiven.config.AbstractJGivenConfiguration
- getTestMethodName() - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- getTitle() - Method in class com.tngtech.jgiven.attachment.Attachment
-
An optional title of the attachment.
- getTitle() - Method in class com.tngtech.jgiven.report.AbstractReportConfig
- getTitle() - Method in class com.tngtech.jgiven.report.model.AttachmentModel
- getTotalStatistics() - Method in class com.tngtech.jgiven.report.model.CompleteReportModel
- getType() - Method in class com.tngtech.jgiven.attachment.MediaType
-
The type of the Media Type.
- getType() - Method in class com.tngtech.jgiven.report.model.Tag
- getValue() - Method in class com.tngtech.jgiven.report.config.ConfigOption
- getValue() - Method in class com.tngtech.jgiven.report.model.AttachmentModel
- getValue() - Method in class com.tngtech.jgiven.report.model.NamedArgument
- getValue() - Method in class com.tngtech.jgiven.report.model.Word
- getValue(ConfigOption) - Method in class com.tngtech.jgiven.report.config.ConfigOptionParser
- getValues() - Method in class com.tngtech.jgiven.report.model.Tag
- getValueString() - Method in class com.tngtech.jgiven.report.model.Tag
- getWord(int) - Method in class com.tngtech.jgiven.report.model.StepModel
- getWords() - Method in class com.tngtech.jgiven.report.model.StepModel
- GIF - Static variable in class com.tngtech.jgiven.attachment.MediaType
-
image/gif
- given() - Method in class com.tngtech.jgiven.base.ScenarioTestBase
- given() - Method in class com.tngtech.jgiven.Stage
- guaranteed() - Element in annotation interface com.tngtech.jgiven.annotation.ProvidedScenarioState
- guaranteed() - Element in annotation interface com.tngtech.jgiven.annotation.ScenarioState
H
- handleReportModel(ReportModelFile) - Method in interface com.tngtech.jgiven.report.json.ReportModelFileHandler
- handleReportModel(ReportModelFile) - Method in class com.tngtech.jgiven.report.json.ReportModelReader
- handleReportModel(ReportModel, File) - Method in class com.tngtech.jgiven.report.text.PlainTextReportGenerator
- hasArgument() - Method in class com.tngtech.jgiven.report.config.CommandLineOption
- hasAttachment() - Method in class com.tngtech.jgiven.report.model.StepModel
- hasDefault() - Method in class com.tngtech.jgiven.report.config.ConfigOption
- hasDescription() - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- hasDescriptions() - Method in class com.tngtech.jgiven.report.model.CasesTable
- hasExtendedDescription() - Method in class com.tngtech.jgiven.report.model.StepModel
- hashCode() - Method in class com.tngtech.jgiven.report.model.ArgumentInfo
- hashCode() - Method in class com.tngtech.jgiven.report.model.DataTable
- hashCode() - Method in class com.tngtech.jgiven.report.model.NamedArgument
- hashCode() - Method in class com.tngtech.jgiven.report.model.Tag
- hashCode() - Method in class com.tngtech.jgiven.report.model.Word
- hasHorizontalHeader() - Method in class com.tngtech.jgiven.report.model.DataTable
- hasInlineAttachment() - Method in class com.tngtech.jgiven.report.model.StepModel
- hasShortFlag() - Method in class com.tngtech.jgiven.report.config.CommandLineOption
- hasVerticalHeader() - Method in class com.tngtech.jgiven.report.model.DataTable
- header() - Element in annotation interface com.tngtech.jgiven.annotation.Table
-
Specifies the header type of the table.
- header() - Method in class com.tngtech.jgiven.format.table.FieldBasedRowFormatter
- header() - Method in class com.tngtech.jgiven.format.table.PlainRowFormatter
- header() - Method in class com.tngtech.jgiven.format.table.RowFormatter
-
Generates the header row of the data table
- Hidden - Annotation Interface in com.tngtech.jgiven.annotation
-
Annotates elements that should be hidden in reports.
- HORIZONTAL - Enum constant in enum class com.tngtech.jgiven.annotation.Table.HeaderType
-
Treat the first row as a header
- href() - Element in annotation interface com.tngtech.jgiven.annotation.IsTag
-
An optional href of the tag that will appear in the generated report.
- href(String) - Method in class com.tngtech.jgiven.config.TagConfiguration.Builder
- hrefGenerator() - Element in annotation interface com.tngtech.jgiven.annotation.IsTag
-
An optional href generator that is used to dynamically generate the href depending on the concrete value of an annotation.
- hrefGenerator(Class<? extends TagHrefGenerator>) - Method in class com.tngtech.jgiven.config.TagConfiguration.Builder
- HTML - Enum constant in enum class com.tngtech.jgiven.report.ReportGenerator.Format
- HTML5 - Enum constant in enum class com.tngtech.jgiven.report.ReportGenerator.Format
I
- ignoreValue() - Element in annotation interface com.tngtech.jgiven.annotation.IsTag
-
Whether values should be ignored.
- ignoreValue(boolean) - Method in class com.tngtech.jgiven.config.TagConfiguration.Builder
- image(String) - Static method in class com.tngtech.jgiven.attachment.MediaType
-
Creates a binary image media type with the given subtype.
- IMAGE - Enum constant in enum class com.tngtech.jgiven.attachment.MediaType.Type
- imageUtf8(String) - Static method in class com.tngtech.jgiven.attachment.MediaType
-
Creates a textual image media type with the given subtype and UTF-8 encoding
- includeFields() - Element in annotation interface com.tngtech.jgiven.annotation.POJOFormat
-
Specifies which fields should be included in the report.
- includeFields() - Element in annotation interface com.tngtech.jgiven.annotation.Table
-
Specifies which fields should be included in the report.
- includeNullColumns() - Element in annotation interface com.tngtech.jgiven.annotation.POJOFormat
-
Whether or not columns with only
null
values are shown or not. - includeNullColumns() - Element in annotation interface com.tngtech.jgiven.annotation.Table
-
Whether or not columns with only
null
values are shown or not. - INDENT - Static variable in class com.tngtech.jgiven.report.text.PlainTextScenarioWriter
- INSTANCE - Static variable in class com.tngtech.jgiven.format.DefaultFormatter
- introWord(String) - Static method in class com.tngtech.jgiven.report.model.Word
- IntroWord - Annotation Interface in com.tngtech.jgiven.annotation
-
Marks a method as an introduction word of a step.
- InvocationMode - Enum Class in com.tngtech.jgiven.report.model
- isArg() - Method in class com.tngtech.jgiven.report.model.Word
- isBinary() - Method in class com.tngtech.jgiven.attachment.MediaType
-
Whether this media type is binary or not.
- isBinary() - Method in class com.tngtech.jgiven.report.model.AttachmentModel
- isCasesAsTable() - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- isDataTable() - Method in class com.tngtech.jgiven.report.model.ArgumentInfo
- isDataTable() - Method in class com.tngtech.jgiven.report.model.Word
- isDifferent() - Method in class com.tngtech.jgiven.report.model.Word
- isExplodeArray() - Method in class com.tngtech.jgiven.config.TagConfiguration
- isFailed() - Method in class com.tngtech.jgiven.report.model.StepModel
- isHasArgument() - Method in class com.tngtech.jgiven.report.config.ConfigOption
- isHorizontal() - Method in enum class com.tngtech.jgiven.annotation.Table.HeaderType
- isIgnoreValue() - Method in class com.tngtech.jgiven.config.TagConfiguration
- isImage() - Method in class com.tngtech.jgiven.attachment.MediaType
- isIntroWord() - Method in class com.tngtech.jgiven.report.model.Word
- isOptional() - Method in class com.tngtech.jgiven.report.config.ConfigOption
- isParameter() - Method in class com.tngtech.jgiven.report.model.ArgumentInfo
- isParentFailed() - Method in class com.tngtech.jgiven.report.model.StepModel
- isPending() - Method in class com.tngtech.jgiven.report.model.StepModel
- isPrependType() - Method in class com.tngtech.jgiven.config.TagConfiguration
- isPrependType() - Method in class com.tngtech.jgiven.report.model.Tag
- isSectionTitle() - Method in class com.tngtech.jgiven.report.model.StepModel
- isShowDirectly() - Method in class com.tngtech.jgiven.report.model.AttachmentModel
- isSkipped() - Method in class com.tngtech.jgiven.report.model.StepModel
- IsTag - Annotation Interface in com.tngtech.jgiven.annotation
-
Marks an annotation to be used as a tag in JGiven reports.
- isVertical() - Method in enum class com.tngtech.jgiven.annotation.Table.HeaderType
J
- JGivenConfiguration - Annotation Interface in com.tngtech.jgiven.annotation
-
This annotation can be applied to a test class to configure: Tags Global formatter Default
As
provider - JGivenExecutionException - Exception in com.tngtech.jgiven.exception
-
This exception is thrown when JGiven tried to execute a used defined method, but the method could not be executed for some reason.
- JGivenExecutionException(String, Throwable) - Constructor for exception com.tngtech.jgiven.exception.JGivenExecutionException
- JGivenInjectionException - Exception in com.tngtech.jgiven.exception
- JGivenInjectionException(String, Exception) - Constructor for exception com.tngtech.jgiven.exception.JGivenInjectionException
- JGivenInstallationException - Exception in com.tngtech.jgiven.exception
- JGivenInstallationException(String) - Constructor for exception com.tngtech.jgiven.exception.JGivenInstallationException
- JGivenInstallationException(String, Throwable) - Constructor for exception com.tngtech.jgiven.exception.JGivenInstallationException
- JGivenInternalDefectException - Exception in com.tngtech.jgiven.exception
-
If this exception is thrown there is most likely a bug in JGiven.
- JGivenInternalDefectException(String) - Constructor for exception com.tngtech.jgiven.exception.JGivenInternalDefectException
- JGivenInternalDefectException(String, Exception) - Constructor for exception com.tngtech.jgiven.exception.JGivenInternalDefectException
- JGivenMissingGuaranteedScenarioStateException - Exception in com.tngtech.jgiven.exception
- JGivenMissingGuaranteedScenarioStateException(Field) - Constructor for exception com.tngtech.jgiven.exception.JGivenMissingGuaranteedScenarioStateException
- JGivenMissingRequiredScenarioStateException - Exception in com.tngtech.jgiven.exception
-
This exception is thrown if a scenario state has been marked as required, but the state has not been provided.
- JGivenMissingRequiredScenarioStateException(Field) - Constructor for exception com.tngtech.jgiven.exception.JGivenMissingRequiredScenarioStateException
- JGivenUserException - Exception in com.tngtech.jgiven.exception
-
This exception is thrown when JGiven tried to execute a user-defined method and that method has thrown an exception.
- JGivenUserException(Method, String, Throwable) - Constructor for exception com.tngtech.jgiven.exception.JGivenUserException
- JGivenWrongUsageException - Exception in com.tngtech.jgiven.exception
-
Thrown when JGiven was used in some wrong way.
- JGivenWrongUsageException(String) - Constructor for exception com.tngtech.jgiven.exception.JGivenWrongUsageException
- JGivenWrongUsageException(String, Class<?>) - Constructor for exception com.tngtech.jgiven.exception.JGivenWrongUsageException
- JGivenWrongUsageException(String, Class<?>, Exception) - Constructor for exception com.tngtech.jgiven.exception.JGivenWrongUsageException
- JGivenWrongUsageException(String, Exception) - Constructor for exception com.tngtech.jgiven.exception.JGivenWrongUsageException
- joinToNextWord() - Element in annotation interface com.tngtech.jgiven.annotation.FillerWord
-
In reports, filler words marked with joinToNextWord will be prefixed to the next word in the sentence without whitespace.
- joinToPreviousWord() - Element in annotation interface com.tngtech.jgiven.annotation.FillerWord
-
In reports, filler words marked with joinToPreviousWord will be suffixed to the previous word in the sentence without whitespace.
- JPEG - Static variable in class com.tngtech.jgiven.attachment.MediaType
-
image/jpeg
- json(String) - Static method in class com.tngtech.jgiven.attachment.Attachment
-
Creates a text attachment with the given content with media type application/json.
- JSON_UTF_8 - Static variable in class com.tngtech.jgiven.attachment.MediaType
-
application/json
- JsonModelTraverser - Class in com.tngtech.jgiven.report.json
- JsonModelTraverser() - Constructor for class com.tngtech.jgiven.report.json.JsonModelTraverser
- JsonReaderException(File, Exception) - Constructor for exception com.tngtech.jgiven.report.json.ScenarioJsonReader.JsonReaderException
K
- kommentiere(String) - Method in class com.tngtech.jgiven.lang.de.Stufe
L
- loadReportModel() - Method in class com.tngtech.jgiven.report.AbstractReportGenerator
M
- main(String...) - Static method in class com.tngtech.jgiven.report.ReportGenerator
- mais() - Method in class com.tngtech.jgiven.lang.fr.Etape
- mais_que() - Method in class com.tngtech.jgiven.lang.fr.Etape
- mas() - Method in class com.tngtech.jgiven.lang.pt.Etapa
- MediaType - Class in com.tngtech.jgiven.attachment
-
Represents a (simplified) Media Type.
- MediaType.Type - Enum Class in com.tngtech.jgiven.attachment
-
Represents the type of a Media Type
- mit() - Method in class com.tngtech.jgiven.lang.de.Stufe
- model() - Method in class com.tngtech.jgiven.report.model.ReportModelFile
- models - Variable in class com.tngtech.jgiven.report.model.CompleteReportModel
N
- name - Variable in class com.tngtech.jgiven.report.model.NamedArgument
- name() - Element in annotation interface com.tngtech.jgiven.annotation.IsTag
-
An optional name that overrides the default which is the name of the annotation.
- name() - Element in annotation interface com.tngtech.jgiven.annotation.NamedFormat
-
Specify a name identifying this format
- name(String) - Method in class com.tngtech.jgiven.config.TagConfiguration.Builder
- NAME - Enum constant in enum class com.tngtech.jgiven.annotation.ScenarioState.Resolution
- NamedArgument - Class in com.tngtech.jgiven.report.model
- NamedArgument(String, Object) - Constructor for class com.tngtech.jgiven.report.model.NamedArgument
- NamedFormat - Annotation Interface in com.tngtech.jgiven.annotation
-
Allow to specify an identifiable format
- NamedFormats - Annotation Interface in com.tngtech.jgiven.annotation
-
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. - NESTED - Enum constant in enum class com.tngtech.jgiven.report.model.InvocationMode
- NESTED_HEADING - Static variable in class com.tngtech.jgiven.report.text.PlainTextScenarioWriter
- NESTED_INDENT - Static variable in class com.tngtech.jgiven.report.text.PlainTextScenarioWriter
- NestedSteps - Annotation Interface in com.tngtech.jgiven.annotation
-
Marks a step method to have nested steps.
- NO_VALUE - Static variable in annotation interface com.tngtech.jgiven.annotation.As
-
Dummy value to indicate that no value was set
- NO_VALUE - Static variable in annotation interface com.tngtech.jgiven.annotation.CaseAs
-
Dummy value to indicate that no value was set
- nonBinary(MediaType.Type, String, Charset) - Static method in class com.tngtech.jgiven.attachment.MediaType
-
Creates a non-binary media type with the given type, subtype, and charSet
- nonBinaryUtf8(MediaType.Type, String) - Static method in class com.tngtech.jgiven.attachment.MediaType
-
Creates a non-binary media type with the given type, subtype, and UTF-8 encoding
- NONE - Enum constant in enum class com.tngtech.jgiven.annotation.POJOFormat.BracketsEnum
- NONE - Enum constant in enum class com.tngtech.jgiven.annotation.Table.HeaderType
-
The table has no header
- NORMAL - Enum constant in enum class com.tngtech.jgiven.report.model.InvocationMode
- NotFormatter - Class in com.tngtech.jgiven.format
-
Translates
false
to the word "not" andtrue
to the empty word "". - NotFormatter() - Constructor for class com.tngtech.jgiven.format.NotFormatter
- numAbortedScenarios - Variable in class com.tngtech.jgiven.report.model.ReportStatistics
- numberedColumns() - Element in annotation interface com.tngtech.jgiven.annotation.Table
-
Automatically number the columns of a table Default is not to generate one.
- numberedColumnsHeader() - Element in annotation interface com.tngtech.jgiven.annotation.Table
-
Like
Table.numberedColumns()
but specifies a different header for the generated row. - numberedRows() - Element in annotation interface com.tngtech.jgiven.annotation.Table
-
Automatically number the rows of the table Default is not to generate one.
- numberedRowsHeader() - Element in annotation interface com.tngtech.jgiven.annotation.Table
-
Like
Table.numberedRows()
but specifies a different header for the generated column. - numCases - Variable in class com.tngtech.jgiven.report.model.ReportStatistics
- numClasses - Variable in class com.tngtech.jgiven.report.model.ReportStatistics
- numFailedCases - Variable in class com.tngtech.jgiven.report.model.ReportStatistics
- numFailedScenarios - Variable in class com.tngtech.jgiven.report.model.ReportStatistics
- numPendingScenarios - Variable in class com.tngtech.jgiven.report.model.ReportStatistics
- numScenarios - Variable in class com.tngtech.jgiven.report.model.ReportStatistics
- numSteps - Variable in class com.tngtech.jgiven.report.model.ReportStatistics
- numSuccessfulScenarios - Variable in class com.tngtech.jgiven.report.model.ReportStatistics
O
- ObjectFormatter<T> - Interface in com.tngtech.jgiven.format
-
General interface to format Objects to Strings
- objectFormatting() - Element in annotation interface com.tngtech.jgiven.annotation.Table
-
How to format rows when the rows are plain Objects, i.e.
P
- PARENTHESES - Enum constant in enum class com.tngtech.jgiven.annotation.POJOFormat.BracketsEnum
- PASSED - Enum constant in enum class com.tngtech.jgiven.report.model.StepStatus
- Pending - Annotation Interface in com.tngtech.jgiven.annotation
-
Marks methods of step definitions as not implemented yet.
- PENDING - Enum constant in enum class com.tngtech.jgiven.report.model.InvocationMode
- PENDING - Enum constant in enum class com.tngtech.jgiven.report.model.StepStatus
- pendingScenarios - Variable in class com.tngtech.jgiven.report.model.CompleteReportModel
- pero() - Method in class com.tngtech.jgiven.lang.es.Fase
- placeholders() - Method in class com.tngtech.jgiven.report.model.CasesTable
-
The placeholders of the data table.
- PLAIN - Enum constant in enum class com.tngtech.jgiven.annotation.Table.ObjectFormatting
-
There is only one column and the values are created by formatting each Object using the standard JGiven formatting.
- PLAIN_TEXT_UTF_8 - Static variable in class com.tngtech.jgiven.attachment.MediaType
-
text/plain
- PlainRowFormatter - Class in com.tngtech.jgiven.format.table
-
Formats each row by just using the default formatting of an object.
- PlainRowFormatter(Class<?>, Table, String, Annotation[], FormatterConfiguration, ObjectFormatter) - Constructor for class com.tngtech.jgiven.format.table.PlainRowFormatter
- PlainRowFormatter.Factory - Class in com.tngtech.jgiven.format.table
-
Factory for creating instances of
PlainRowFormatter
- plainText(String) - Static method in class com.tngtech.jgiven.attachment.Attachment
-
Creates a text attachment with the given content with media type text/plain.
- PlainTextReportConfig - Class in com.tngtech.jgiven.report.text
- PlainTextReportConfig() - Constructor for class com.tngtech.jgiven.report.text.PlainTextReportConfig
- PlainTextReportConfig(String...) - Constructor for class com.tngtech.jgiven.report.text.PlainTextReportConfig
- PlainTextReporter - Class in com.tngtech.jgiven.report.text
-
Generates a plain text report to a PrintStream.
- PlainTextReporter() - Constructor for class com.tngtech.jgiven.report.text.PlainTextReporter
- PlainTextReporter(ConfigValue) - Constructor for class com.tngtech.jgiven.report.text.PlainTextReporter
- PlainTextReporter(PrintWriter, ConfigValue) - Constructor for class com.tngtech.jgiven.report.text.PlainTextReporter
- PlainTextReportGenerator - Class in com.tngtech.jgiven.report.text
- PlainTextReportGenerator() - Constructor for class com.tngtech.jgiven.report.text.PlainTextReportGenerator
- PlainTextScenarioWriter - Class in com.tngtech.jgiven.report.text
- PlainTextScenarioWriter(PrintWriter, boolean) - Constructor for class com.tngtech.jgiven.report.text.PlainTextScenarioWriter
- PlainTextTableWriter - Class in com.tngtech.jgiven.report.text
- PlainTextTableWriter(PrintWriter, boolean) - Constructor for class com.tngtech.jgiven.report.text.PlainTextTableWriter
- PlainTextWriter - Class in com.tngtech.jgiven.report.text
- PlainTextWriter(PrintWriter, boolean) - Constructor for class com.tngtech.jgiven.report.text.PlainTextWriter
- PNG - Static variable in class com.tngtech.jgiven.attachment.MediaType
-
image/png
- POINTY - Enum constant in enum class com.tngtech.jgiven.annotation.POJOFormat.BracketsEnum
- POJOAnnotationFormatter - Class in com.tngtech.jgiven.format
-
AnnotationArgumentFormatter
that is used by thePOJOFormat
annotation - POJOAnnotationFormatter() - Constructor for class com.tngtech.jgiven.format.POJOAnnotationFormatter
- POJOFormat - Annotation Interface in com.tngtech.jgiven.annotation
-
A special format annotation to format POJOs
- POJOFormat.BracketsEnum - Enum Class in com.tngtech.jgiven.annotation
-
Enumeration of opening/closing brackets pair :
POJOFormat.BracketsEnum.NONE
: no bracketsPOJOFormat.BracketsEnum.PARENTHESES
:(...)
POJOFormat.BracketsEnum.SQUARE
:[...]
POJOFormat.BracketsEnum.BRACES
:{...}
POJOFormat.BracketsEnum.POINTY
:<...>
POJOFormat.BracketsEnum.CHEVRONS
:<<...>>
POJOFormat.BracketsEnum.DOUBLE_QUOTE
:"..."
POJOFormat.BracketsEnum.SINGLE_QUOTE
:'...'
- postProcess(List<List<String>>) - Method in class com.tngtech.jgiven.format.table.FieldBasedRowFormatter
- postProcess(List<List<String>>) - Method in class com.tngtech.jgiven.format.table.RowFormatter
-
Allows for post processing the resulting data table.
- prefixWithFieldName() - Element in annotation interface com.tngtech.jgiven.annotation.POJOFormat
-
When set to
true
, each formatted field value is prefixed by its field name - prependType() - Element in annotation interface com.tngtech.jgiven.annotation.IsTag
-
Whether the type should be prepended to the tag if the tag has a value.
- prependType(boolean) - Method in class com.tngtech.jgiven.config.TagConfiguration.Builder
- printCaseLine(ScenarioCaseModel) - Method in class com.tngtech.jgiven.report.text.DataTablePlainTextScenarioWriter
- printCaseLine(ScenarioCaseModel) - Method in class com.tngtech.jgiven.report.text.PlainTextScenarioWriter
- PrintfAnnotationFormatter - Class in com.tngtech.jgiven.format
-
AnnotationArgumentFormatter
that is used by theFormatf
annotation - PrintfAnnotationFormatter() - Constructor for class com.tngtech.jgiven.format.PrintfAnnotationFormatter
- PrintfFormatter - Class in com.tngtech.jgiven.format
-
Formatter to use a Java format string to format arguments.
- PrintfFormatter() - Constructor for class com.tngtech.jgiven.format.PrintfFormatter
- printUsageAndExit() - Method in class com.tngtech.jgiven.report.AbstractReportConfig
- printUsageAndExit(List<ConfigOption>) - Method in class com.tngtech.jgiven.report.config.ConfigOptionParser
-
Creates a help message based on the descriptions of the
ConfigOption
and terminates - ProvidedScenarioState - Annotation Interface in com.tngtech.jgiven.annotation
-
Marks fields to be provided by a scenario stage.
- provider() - Element in annotation interface com.tngtech.jgiven.annotation.As
-
An optional provider to generate the representation of the stage method, scenario or scenario class.
- provider() - Element in annotation interface com.tngtech.jgiven.annotation.CaseAs
-
A custom implementation of the
CaseAsProvider
to provide a case description.
Q
- quand() - Method in class com.tngtech.jgiven.lang.fr.Etape
- quand() - Method in class com.tngtech.jgiven.lang.fr.SimpleTestDeScenarioBase
- quand() - Method in class com.tngtech.jgiven.lang.fr.TestDeScenarioBase
- quando() - Method in class com.tngtech.jgiven.lang.pt.CenarioTesteBase
- quando() - Method in class com.tngtech.jgiven.lang.pt.Etapa
- quando() - Method in class com.tngtech.jgiven.lang.pt.SimplesCenarioTesteBase
- Quoted - Annotation Interface in com.tngtech.jgiven.annotation
-
Step parameters annotated with this annotation will be put into quotes (" ") in reports.
R
- readDirectory() - Method in class com.tngtech.jgiven.report.json.ReportModelReader
- repeatable() - Element in annotation interface com.tngtech.jgiven.annotation.AfterStage
-
marks an after stage method for repeated execution.
- repeatable() - Element in annotation interface com.tngtech.jgiven.annotation.BeforeStage
-
marks a before stage method for repeated execution.
- ReportBlockConverter - Interface in com.tngtech.jgiven.report
-
Converts elements of the report model into standalone text blocks.
- ReportGenerator - Class in com.tngtech.jgiven.report
-
This is an interface to create a report based on command line flags
- ReportGenerator() - Constructor for class com.tngtech.jgiven.report.ReportGenerator
- ReportGenerator.Format - Enum Class in com.tngtech.jgiven.report
-
to create a custom report, extend this enum with the name of your choice
- ReportModel - Class in com.tngtech.jgiven.report.model
- ReportModel() - Constructor for class com.tngtech.jgiven.report.model.ReportModel
- ReportModelFile - Class in com.tngtech.jgiven.report.model
- ReportModelFile(File, ReportModel) - Constructor for class com.tngtech.jgiven.report.model.ReportModelFile
- ReportModelFileHandler - Interface in com.tngtech.jgiven.report.json
-
Handles a single ReportModel that has been read from a single JSON file.
- ReportModelReader - Class in com.tngtech.jgiven.report.json
- ReportModelReader(AbstractReportConfig) - Constructor for class com.tngtech.jgiven.report.json.ReportModelReader
- ReportModelVisitor - Class in com.tngtech.jgiven.report.model
- ReportModelVisitor() - Constructor for class com.tngtech.jgiven.report.model.ReportModelVisitor
- ReportStatistics - Class in com.tngtech.jgiven.report.model
- ReportStatistics() - Constructor for class com.tngtech.jgiven.report.model.ReportStatistics
- required() - Element in annotation interface com.tngtech.jgiven.annotation.ExpectedScenarioState
-
Marks this state as required for the stage.
- required() - Element in annotation interface com.tngtech.jgiven.annotation.ScenarioState
-
Marks this state as required for the stage.
- resolution() - Element in annotation interface com.tngtech.jgiven.annotation.ExpectedScenarioState
- resolution() - Element in annotation interface com.tngtech.jgiven.annotation.ProvidedScenarioState
- resolution() - Element in annotation interface com.tngtech.jgiven.annotation.ScenarioState
- rowFormatter() - Element in annotation interface com.tngtech.jgiven.annotation.Table
-
Specifies a factory to create a custom
RowFormatter
that is used to format POJOs each row of the table. - RowFormatter - Class in com.tngtech.jgiven.format.table
-
Formats the rows of a data table.
- RowFormatter() - Constructor for class com.tngtech.jgiven.format.table.RowFormatter
- RowFormatterFactory - Interface in com.tngtech.jgiven.format.table
-
Factory for creating ObjectRowFormatter instances
- rowNumber() - Method in class com.tngtech.jgiven.report.model.CasesTable.CaseRow
-
The row number starting from 1.
- rows() - Method in class com.tngtech.jgiven.report.model.CasesTable
-
The rows of the table, not including the header.
S
- SCENARIO_PENDING - Enum constant in enum class com.tngtech.jgiven.report.model.ExecutionStatus
- ScenarioCaseModel - Class in com.tngtech.jgiven.report.model
- ScenarioCaseModel() - Constructor for class com.tngtech.jgiven.report.model.ScenarioCaseModel
- ScenarioJsonReader - Class in com.tngtech.jgiven.report.json
- ScenarioJsonReader() - Constructor for class com.tngtech.jgiven.report.json.ScenarioJsonReader
- ScenarioJsonReader.JsonReaderException - Exception in com.tngtech.jgiven.report.json
- ScenarioJsonWriter - Class in com.tngtech.jgiven.report.json
- ScenarioJsonWriter(ReportModel) - Constructor for class com.tngtech.jgiven.report.json.ScenarioJsonWriter
- ScenarioModel - Class in com.tngtech.jgiven.report.model
- ScenarioModel() - Constructor for class com.tngtech.jgiven.report.model.ScenarioModel
- ScenarioModel(ScenarioModel) - Constructor for class com.tngtech.jgiven.report.model.ScenarioModel
-
Shallow copy a scenario model.
- ScenarioRule - Annotation Interface in com.tngtech.jgiven.annotation
-
Marks fields to be Scenario rules.
- ScenarioStage - Annotation Interface in com.tngtech.jgiven.annotation
-
Marks fields to be stage instances This is useful to reuse stages within stages.
- ScenarioState - Annotation Interface in com.tngtech.jgiven.annotation
-
Marks fields to be read and/or written by a scenario stage.
- ScenarioState.Resolution - Enum Class in com.tngtech.jgiven.annotation
- ScenarioTestBase<GIVEN,
WHEN, THEN> - Class in com.tngtech.jgiven.base -
Base class for Scenario tests.
- ScenarioTestBase() - Constructor for class com.tngtech.jgiven.base.ScenarioTestBase
- section(String) - Method in class com.tngtech.jgiven.base.ScenarioTestBase
-
Adds a new section to the scenario
- self() - Method in class com.tngtech.jgiven.base.StageBase
- setArgumentDelimiter(String) - Method in class com.tngtech.jgiven.report.config.CommandLineOption
- setArgumentDelimiter(String) - Method in class com.tngtech.jgiven.report.config.CommandLineOptionBuilder
- setArgumentName(String) - Method in class com.tngtech.jgiven.report.model.ArgumentInfo
- setAsProvider(AsProvider) - Method in class com.tngtech.jgiven.config.AbstractJGivenConfiguration
-
Set a default interpreter for method names for all items that are subject to this configuration.
- setCaseNr(int) - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- setCasesAsTable(boolean) - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- setClassName(String) - Method in class com.tngtech.jgiven.report.model.ReportModel
- setClassName(String) - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- setColor(String) - Method in class com.tngtech.jgiven.report.model.Tag
- setCommandLineOption(CommandLineOption) - Method in class com.tngtech.jgiven.report.config.ConfigOption
- setCommandLineOptionWithArgument(CommandLineOption, StringConverter) - Method in class com.tngtech.jgiven.report.config.ConfigOptionBuilder
-
if you want to parse an argument, you need a converter from String to Object
- setCommandLineOptionWithoutArgument(CommandLineOption, Object) - Method in class com.tngtech.jgiven.report.config.ConfigOptionBuilder
-
if you don't have an argument, choose the value that is going to be inserted into the map instead
- setComment(String) - Method in interface com.tngtech.jgiven.CurrentStep
-
Sets the comment of the step.
- setComment(String) - Method in class com.tngtech.jgiven.report.model.StepModel
- setConfig(AbstractReportConfig) - Method in class com.tngtech.jgiven.report.AbstractReportGenerator
- setConverter(StringConverter) - Method in class com.tngtech.jgiven.report.config.ConfigOption
- setCssClass(String) - Method in class com.tngtech.jgiven.report.model.Tag
- setData(List<List<String>>) - Method in class com.tngtech.jgiven.report.model.DataTable
- setDataTable(DataTable) - Method in class com.tngtech.jgiven.report.model.ArgumentInfo
- setDefaultWith(Object) - Method in class com.tngtech.jgiven.report.config.ConfigOptionBuilder
-
if you have a default, it's automatically optional
- setDepth(int) - Method in class com.tngtech.jgiven.report.model.StepModel
- setDerivedArguments(List<String>) - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- setDerivedParameters(Collection<String>) - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- setDescription(String) - Method in class com.tngtech.jgiven.report.config.ConfigOption
- setDescription(String) - Method in class com.tngtech.jgiven.report.config.ConfigOptionBuilder
- setDescription(String) - Method in class com.tngtech.jgiven.report.model.ReportModel
- setDescription(String) - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- setDescription(String) - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- setDescription(String) - Method in class com.tngtech.jgiven.report.model.Tag
- setDurationInNanos(long) - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- setDurationInNanos(long) - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- setDurationInNanos(long) - Method in class com.tngtech.jgiven.report.model.StepModel
- setEnvironmentString(String, StringConverter) - Method in class com.tngtech.jgiven.report.config.ConfigOptionBuilder
- setEnvString(String) - Method in class com.tngtech.jgiven.report.config.ConfigOption
- setErrorMessage(String) - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- setExcludeEmptyScenarios(Boolean) - Method in class com.tngtech.jgiven.report.AbstractReportConfig
- setExplicitArguments(List<String>) - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- setExplicitParameters(List<String>) - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- setExtendedDescription(String) - Method in interface com.tngtech.jgiven.CurrentStep
-
Sets the extended description of the current step
- setExtendedDescription(String) - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- setExtendedDescription(String) - Method in class com.tngtech.jgiven.report.model.StepModel
- setFileName(String) - Method in class com.tngtech.jgiven.report.model.AttachmentModel
- setFormattedValue(String) - Method in class com.tngtech.jgiven.report.model.ArgumentInfo
- setFormatter(Class<T>, Formatter<T>) - Method in class com.tngtech.jgiven.config.AbstractJGivenConfiguration
-
Sets the formatter for the given type.
- setHasArgument(boolean) - Method in class com.tngtech.jgiven.report.config.ConfigOption
- setHasDefault(boolean) - Method in class com.tngtech.jgiven.report.config.ConfigOption
- setHeaderType(Table.HeaderType) - Method in class com.tngtech.jgiven.report.model.DataTable
- setHref(String) - Method in class com.tngtech.jgiven.report.model.Tag
- setIntroWord(boolean) - Method in class com.tngtech.jgiven.report.model.Word
- setIsBinary(boolean) - Method in class com.tngtech.jgiven.report.model.AttachmentModel
- setIsDifferent(boolean) - Method in class com.tngtech.jgiven.report.model.Word
- setIsSectionTitle(boolean) - Method in class com.tngtech.jgiven.report.model.StepModel
- setLongName(String) - Method in class com.tngtech.jgiven.report.config.ConfigOption
- setLongPrefix(String) - Method in class com.tngtech.jgiven.report.config.CommandLineOption
- setMediaType(String) - Method in class com.tngtech.jgiven.report.model.AttachmentModel
- setName(String) - Method in interface com.tngtech.jgiven.CurrentStep
-
Sets the name of the current step.
- setName(String) - Method in class com.tngtech.jgiven.report.model.ReportModel
- setName(String) - Method in class com.tngtech.jgiven.report.model.StepModel
- setName(String) - Method in class com.tngtech.jgiven.report.model.Tag
- setNestedSteps(List<StepModel>) - Method in class com.tngtech.jgiven.report.model.StepModel
- setOptional() - Method in class com.tngtech.jgiven.report.config.ConfigOptionBuilder
-
if the option is optional, you don't have to use it
- setOptional(boolean) - Method in class com.tngtech.jgiven.report.config.ConfigOption
- setParameterName(String) - Method in class com.tngtech.jgiven.report.model.ArgumentInfo
- setParentFailed(boolean) - Method in class com.tngtech.jgiven.report.model.StepModel
- setPlaceholder(String) - Method in class com.tngtech.jgiven.report.config.CommandLineOption
- setPrependType(boolean) - Method in class com.tngtech.jgiven.report.model.Tag
- setPropertyString(String) - Method in class com.tngtech.jgiven.report.config.ConfigOption
- setPropertyString(String, StringConverter) - Method in class com.tngtech.jgiven.report.config.ConfigOptionBuilder
- setScenarios(List<ScenarioModel>) - Method in class com.tngtech.jgiven.report.model.ReportModel
- setShortName(String) - Method in class com.tngtech.jgiven.report.config.ConfigOption
- setShortName(String) - Method in class com.tngtech.jgiven.report.config.ConfigOptionBuilder
- setShortPrefix(String) - Method in class com.tngtech.jgiven.report.config.CommandLineOption
- setShortPrefix(String) - Method in class com.tngtech.jgiven.report.config.CommandLineOptionBuilder
- setShowDirectly(boolean) - Method in class com.tngtech.jgiven.report.model.AttachmentModel
- setShowInNavigation(boolean) - Method in class com.tngtech.jgiven.report.model.Tag
- setSourceDir(File) - Method in class com.tngtech.jgiven.report.AbstractReportConfig
- setStackTrace(List<String>) - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- setStatus(ExecutionStatus) - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- setStatus(StepStatus) - Method in class com.tngtech.jgiven.report.model.StepModel
- setSteps(List<StepModel>) - Method in class com.tngtech.jgiven.report.model.ScenarioCaseModel
- setStringConverter(StringConverter) - Method in class com.tngtech.jgiven.report.config.ConfigOptionBuilder
-
if you want to convert some string to an object, you have an argument to parse
- setStyle(String) - Method in class com.tngtech.jgiven.report.model.Tag
- setTagIds(Set<String>) - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- setTagMap(Map<String, Tag>) - Method in class com.tngtech.jgiven.report.model.ReportModel
- setTags(List<String>) - Method in class com.tngtech.jgiven.report.model.Tag
- setTargetDir(File) - Method in class com.tngtech.jgiven.report.AbstractReportConfig
- setTestClass(Class<?>) - Method in class com.tngtech.jgiven.report.model.ReportModel
- setTestClassSuffixRegEx(String) - Method in class com.tngtech.jgiven.config.AbstractJGivenConfiguration
-
Set a regular expression for a test class suffix that should be removed by JGiven in the report.
- setTestMethodName(String) - Method in class com.tngtech.jgiven.report.model.ScenarioModel
- setTitle(String) - Method in class com.tngtech.jgiven.report.AbstractReportConfig
- setTitle(String) - Method in class com.tngtech.jgiven.report.model.AttachmentModel
- setType(String) - Method in class com.tngtech.jgiven.report.model.Tag
- setValue(Object) - Method in class com.tngtech.jgiven.report.config.ConfigOption
- setValue(String) - Method in class com.tngtech.jgiven.report.model.AttachmentModel
- setValue(String) - Method in class com.tngtech.jgiven.report.model.Tag
- setValue(String) - Method in class com.tngtech.jgiven.report.model.Word
- setValue(List<String>) - Method in class com.tngtech.jgiven.report.model.Tag
- setVisualPlaceholder(String) - Method in class com.tngtech.jgiven.report.config.CommandLineOptionBuilder
- setWords(List<Word>) - Method in class com.tngtech.jgiven.report.model.StepModel
- showDirectly() - Method in class com.tngtech.jgiven.attachment.Attachment
-
Directly shows this attachment in the report.
- showFlagInfo() - Method in class com.tngtech.jgiven.report.config.CommandLineOption
- showInNavigation() - Element in annotation interface com.tngtech.jgiven.annotation.IsTag
-
Whether the tag should be shown in the navigation part of the report
- showInNavigation() - Method in class com.tngtech.jgiven.config.TagConfiguration
- showInNavigation(boolean) - Method in class com.tngtech.jgiven.config.TagConfiguration.Builder
- SimpleEscenarioTestBase<FASE> - Class in com.tngtech.jgiven.lang.es
- SimpleEscenarioTestBase() - Constructor for class com.tngtech.jgiven.lang.es.SimpleEscenarioTestBase
- SimpleScenarioTestBase<STEPS> - Class in com.tngtech.jgiven.base
-
ScenarioTest that only takes a single type parameter that is used for all three step definition types.
- SimpleScenarioTestBase() - Constructor for class com.tngtech.jgiven.base.SimpleScenarioTestBase
- SimplesCenarioTesteBase<ETAPA> - Class in com.tngtech.jgiven.lang.pt
- SimplesCenarioTesteBase() - Constructor for class com.tngtech.jgiven.lang.pt.SimplesCenarioTesteBase
- SimpleTestDeScenarioBase<ETAPE> - Class in com.tngtech.jgiven.lang.fr
- SimpleTestDeScenarioBase() - Constructor for class com.tngtech.jgiven.lang.fr.SimpleTestDeScenarioBase
- SINGLE_QUOTE - Enum constant in enum class com.tngtech.jgiven.annotation.POJOFormat.BracketsEnum
- SingleQuoted - Annotation Interface in com.tngtech.jgiven.annotation
-
Step parameters annotated with this annotation will be put into quotes (' ') in reports.
- SKIPPED - Enum constant in enum class com.tngtech.jgiven.report.model.InvocationMode
- SKIPPED - Enum constant in enum class com.tngtech.jgiven.report.model.StepStatus
- SOME_STEPS_PENDING - Enum constant in enum class com.tngtech.jgiven.report.model.ExecutionStatus
- SQUARE - Enum constant in enum class com.tngtech.jgiven.annotation.POJOFormat.BracketsEnum
- stackTrace() - Method in class com.tngtech.jgiven.report.model.CasesTable.CaseRow
-
The stack trace of the case if any.
- Stage<SELF extends Stage<?>> - Class in com.tngtech.jgiven
-
Base class for Stages.
- Stage() - Constructor for class com.tngtech.jgiven.Stage
- StageBase<SELF extends StageBase<?>> - Class in com.tngtech.jgiven.base
-
Useful base class for step definitions as it provides a
StageBase.self()
method to create fluent interfaces. - StageBase() - Constructor for class com.tngtech.jgiven.base.StageBase
- StatisticsCalculator - Class in com.tngtech.jgiven.report.model
- StatisticsCalculator() - Constructor for class com.tngtech.jgiven.report.model.StatisticsCalculator
- statisticsMap - Variable in class com.tngtech.jgiven.report.model.CompleteReportModel
- status() - Method in class com.tngtech.jgiven.report.model.CasesTable.CaseRow
-
The execution status of the case.
- StepComment - Annotation Interface in com.tngtech.jgiven.annotation
-
Marks a method to be used to provide an additional comment to the previous step.
- StepFormatter - Class in com.tngtech.jgiven.report.model
- StepFormatter(String, List<NamedArgument>, List<ObjectFormatter<?>>) - Constructor for class com.tngtech.jgiven.report.model.StepFormatter
- StepFormatter.AnnotationBasedFormatter - Class in com.tngtech.jgiven.report.model
- StepFormatter.ArgumentFormatting<F extends ArgumentFormatter<T>,
T> - Class in com.tngtech.jgiven.report.model - StepFormatter.ChainedFormatting<T> - Class in com.tngtech.jgiven.report.model
- StepFormatter.Formatting<F,
T> - Class in com.tngtech.jgiven.report.model - StepFormatter.TableFormatting<F extends TableFormatter> - Class in com.tngtech.jgiven.report.model
- StepFormatter.TypeBasedFormatting<T> - Class in com.tngtech.jgiven.report.model
- StepFunction<STAGE> - Interface in com.tngtech.jgiven
-
A functional interface for defining ad-hoc steps.
- StepModel - Class in com.tngtech.jgiven.report.model
- StepModel() - Constructor for class com.tngtech.jgiven.report.model.StepModel
- StepModel(String, List<Word>) - Constructor for class com.tngtech.jgiven.report.model.StepModel
- StepStatus - Enum Class in com.tngtech.jgiven.report.model
- StringConverter - Interface in com.tngtech.jgiven.report.config.converter
-
Interface to create converter function to specify the to map the incoming command line argument to the object See
AbstractReportGenerator
for example definitions ofConfigOption
If the conversion is not possible, return null. - Stufe<SELF extends Stufe<?>> - Class in com.tngtech.jgiven.lang.de
-
Eine deutsche Version der
Stage
-Klasse. - Stufe() - Constructor for class com.tngtech.jgiven.lang.de.Stufe
- style() - Element in annotation interface com.tngtech.jgiven.annotation.IsTag
-
Defines an inline style that is used in the HTML report for this tag.
- style(String) - Method in class com.tngtech.jgiven.config.TagConfiguration.Builder
- SUCCESS - Enum constant in enum class com.tngtech.jgiven.report.model.ExecutionStatus
- SUFFIX - Static variable in exception com.tngtech.jgiven.exception.JGivenInstallationException
- SVG_UTF_8 - Static variable in class com.tngtech.jgiven.attachment.MediaType
-
image/svg+xml
- SzenarioTestBasis<GEGEBEN,
WENN, DANN> - Class in com.tngtech.jgiven.lang.de - SzenarioTestBasis() - Constructor for class com.tngtech.jgiven.lang.de.SzenarioTestBasis
T
- table(int, Object...) - Static method in class com.tngtech.jgiven.DataTables
-
Creates a table, i.e.
- Table - Annotation Interface in com.tngtech.jgiven.annotation
-
Marks the parameter of a step method as a data table.
- Table.HeaderType - Enum Class in com.tngtech.jgiven.annotation
- Table.ObjectFormatting - Enum Class in com.tngtech.jgiven.annotation
-
Possible choices for the
Table.objectFormatting()
attribute. - TableFormatter - Interface in com.tngtech.jgiven.format.table
-
Formatter that will format arguments as a table.
- TableFormatterFactory - Interface in com.tngtech.jgiven.format.table
-
Factory to create a custom
TableFormatter
- TableFormatting(F, Table, String, Annotation...) - Constructor for class com.tngtech.jgiven.report.model.StepFormatter.TableFormatting
- Tag - Class in com.tngtech.jgiven.report.model
-
A tag represents a Java annotation of a scenario-test.
- Tag(String) - Constructor for class com.tngtech.jgiven.report.model.Tag
- Tag(String, Object) - Constructor for class com.tngtech.jgiven.report.model.Tag
- Tag(String, String, Object) - Constructor for class com.tngtech.jgiven.report.model.Tag
- TagConfiguration - Class in com.tngtech.jgiven.config
-
Represents the configuration of a tag.
- TagConfiguration(Class<? extends Annotation>) - Constructor for class com.tngtech.jgiven.config.TagConfiguration
- TagConfiguration.Builder - Class in com.tngtech.jgiven.config
- TagDescriptionGenerator - Interface in com.tngtech.jgiven.annotation
-
Is used as an attribute of the
IsTag
annotation to dynamically generate a description for an annotation depending on its value. - TagHrefGenerator - Interface in com.tngtech.jgiven.annotation
-
Is used as an attribute of the
IsTag
annotation to dynamically generate an href for an annotation depending on its value. - tagIdMap - Variable in class com.tngtech.jgiven.report.model.CompleteReportModel
- tagMap - Variable in class com.tngtech.jgiven.report.model.CompleteReportModel
- tags(List<String>) - Method in class com.tngtech.jgiven.config.TagConfiguration.Builder
- TestDeScenarioBase<ETANT_DONNE,
QUAND, ALORS> - Class in com.tngtech.jgiven.lang.fr - TestDeScenarioBase() - Constructor for class com.tngtech.jgiven.lang.fr.TestDeScenarioBase
- text(String, Charset) - Static method in class com.tngtech.jgiven.attachment.MediaType
-
Creates a non-binary text media type with the given subtype and a specified encoding
- TEXT - Enum constant in enum class com.tngtech.jgiven.attachment.MediaType.Type
- TEXT - Enum constant in enum class com.tngtech.jgiven.report.ReportGenerator.Format
- textUtf8(String) - Static method in class com.tngtech.jgiven.attachment.MediaType
-
Creates a non-binary text media type with the given subtype.
- then() - Method in class com.tngtech.jgiven.base.ScenarioTestBase
- then() - Method in class com.tngtech.jgiven.Stage
- ToBoolean - Class in com.tngtech.jgiven.report.config.converter
-
Total conversion function
- ToBoolean() - Constructor for class com.tngtech.jgiven.report.config.converter.ToBoolean
- toEscapedString() - Method in class com.tngtech.jgiven.report.model.Tag
-
Returns a string representation where all non-alphanumeric characters are replaced with an underline (_).
- ToFile - Class in com.tngtech.jgiven.report.config.converter
-
Total conversion function
- ToFile() - Constructor for class com.tngtech.jgiven.report.config.converter.ToFile
- ToFormat - Class in com.tngtech.jgiven.report.config.converter
-
Not total, if the format parse fails it returns null
- ToFormat() - Constructor for class com.tngtech.jgiven.report.config.converter.ToFormat
- toIdString() - Method in class com.tngtech.jgiven.report.model.Tag
- toObject(String) - Method in class com.tngtech.jgiven.report.config.ConfigOption
- toStepStatus() - Method in enum class com.tngtech.jgiven.report.model.InvocationMode
- toString() - Method in class com.tngtech.jgiven.attachment.MediaType
- toString() - Method in enum class com.tngtech.jgiven.attachment.MediaType.Type
- toString() - Method in class com.tngtech.jgiven.report.json.ScenarioJsonWriter
- toString() - Method in class com.tngtech.jgiven.report.model.NamedArgument
- toString() - Method in class com.tngtech.jgiven.report.model.Tag
- toString() - Method in class com.tngtech.jgiven.report.model.Word
- toString(ReportModel) - Static method in class com.tngtech.jgiven.report.text.PlainTextReporter
- toString(ScenarioModel) - Static method in class com.tngtech.jgiven.report.text.PlainTextReporter
- ToString - Class in com.tngtech.jgiven.report.config.converter
-
Total conversion function
- ToString() - Constructor for class com.tngtech.jgiven.report.config.converter.ToString
- totalStatistics - Variable in class com.tngtech.jgiven.report.model.CompleteReportModel
- transpose() - Element in annotation interface com.tngtech.jgiven.annotation.Table
-
Whether to transpose the resulting table in the report or not.
- traverseModels(File, ReportModelFileHandler) - Method in class com.tngtech.jgiven.report.json.JsonModelTraverser
-
Reads all JSON files from
sourceDirectory
and invokes for each found file theReportModelFileHandler.handleReportModel(com.tngtech.jgiven.report.model.ReportModelFile)
method of the givenhandler
. - TRUE - Enum constant in enum class com.tngtech.jgiven.config.ConfigValue
- TYPE - Enum constant in enum class com.tngtech.jgiven.annotation.ScenarioState.Resolution
- TypeBasedFormatting(Formatter<T>, Annotation[]) - Constructor for class com.tngtech.jgiven.report.model.StepFormatter.TypeBasedFormatting
U
- und() - Method in class com.tngtech.jgiven.lang.de.Stufe
- useConfigMap(Map<String, Object>) - Method in class com.tngtech.jgiven.report.AbstractReportConfig
-
Every flag should be defined except the optional ones without a default (like --help)
- useConfigMap(Map<String, Object>) - Method in class com.tngtech.jgiven.report.asciidoc.AsciiDocReportConfig
- useConfigMap(Map<String, Object>) - Method in class com.tngtech.jgiven.report.text.PlainTextReportConfig
V
- value - Variable in class com.tngtech.jgiven.report.model.NamedArgument
- value() - Element in annotation interface com.tngtech.jgiven.annotation.AnnotationFormat
- value() - Element in annotation interface com.tngtech.jgiven.annotation.As
-
The alternate representation of the step or scenario summary.
- value() - Element in annotation interface com.tngtech.jgiven.annotation.CaseAs
-
The description of the test case.
- value() - Element in annotation interface com.tngtech.jgiven.annotation.Description
-
The description of the test class.
- value() - Element in annotation interface com.tngtech.jgiven.annotation.ExtendedDescription
-
The extended description of the step.
- value() - Element in annotation interface com.tngtech.jgiven.annotation.Format
- value() - Element in annotation interface com.tngtech.jgiven.annotation.Formatf
-
The format string to be used to format the argument.
- value() - Element in annotation interface com.tngtech.jgiven.annotation.IsTag
-
An optional default value for the tag.
- value() - Element in annotation interface com.tngtech.jgiven.annotation.JGivenConfiguration
- value() - Element in annotation interface com.tngtech.jgiven.annotation.NamedFormats
-
Array of
NamedFormat
- value() - Element in annotation interface com.tngtech.jgiven.annotation.Pending
-
Optional description to describe when the implementation will be done.
- valueOf(String) - Static method in enum class com.tngtech.jgiven.annotation.POJOFormat.BracketsEnum
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.tngtech.jgiven.annotation.ScenarioState.Resolution
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.tngtech.jgiven.annotation.Table.HeaderType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.tngtech.jgiven.annotation.Table.ObjectFormatting
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.tngtech.jgiven.attachment.MediaType.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.tngtech.jgiven.config.ConfigValue
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.tngtech.jgiven.report.model.ExecutionStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.tngtech.jgiven.report.model.InvocationMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.tngtech.jgiven.report.model.StepStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.tngtech.jgiven.report.ReportGenerator.Format
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.tngtech.jgiven.annotation.POJOFormat.BracketsEnum
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.tngtech.jgiven.annotation.ScenarioState.Resolution
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.tngtech.jgiven.annotation.Table.HeaderType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.tngtech.jgiven.annotation.Table.ObjectFormatting
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.tngtech.jgiven.attachment.MediaType.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.tngtech.jgiven.config.ConfigValue
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.tngtech.jgiven.report.model.ExecutionStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.tngtech.jgiven.report.model.InvocationMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.tngtech.jgiven.report.model.StepStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.tngtech.jgiven.report.ReportGenerator.Format
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VERTICAL - Enum constant in enum class com.tngtech.jgiven.annotation.Table.HeaderType
-
Treat the first column as a header
- video(String) - Static method in class com.tngtech.jgiven.attachment.MediaType
-
Creates a binary video media type with the given subtype.
- VIDEO - Enum constant in enum class com.tngtech.jgiven.attachment.MediaType.Type
- visit(ReportModel) - Method in class com.tngtech.jgiven.report.model.ReportModelVisitor
- visit(ReportModel) - Method in class com.tngtech.jgiven.report.text.PlainTextReporter
- visit(ScenarioCaseModel) - Method in class com.tngtech.jgiven.report.model.ReportModelVisitor
- visit(ScenarioCaseModel) - Method in class com.tngtech.jgiven.report.text.PlainTextScenarioWriter
- visit(ScenarioModel) - Method in class com.tngtech.jgiven.report.model.ReportModelVisitor
- visit(ScenarioModel) - Method in class com.tngtech.jgiven.report.text.PlainTextReporter
- visit(ScenarioModel) - Method in class com.tngtech.jgiven.report.text.PlainTextScenarioWriter
- visit(StepModel) - Method in class com.tngtech.jgiven.report.model.ReportModelVisitor
- visit(StepModel) - Method in class com.tngtech.jgiven.report.text.DataTablePlainTextScenarioWriter
- visit(StepModel) - Method in class com.tngtech.jgiven.report.text.PlainTextScenarioWriter
- visitEnd(ReportModel) - Method in class com.tngtech.jgiven.report.model.ReportModelVisitor
- visitEnd(ScenarioCaseModel) - Method in class com.tngtech.jgiven.report.model.ReportModelVisitor
- visitEnd(ScenarioCaseModel) - Method in class com.tngtech.jgiven.report.text.DataTablePlainTextScenarioWriter
- visitEnd(ScenarioCaseModel) - Method in class com.tngtech.jgiven.report.text.PlainTextScenarioWriter
- visitEnd(ScenarioModel) - Method in class com.tngtech.jgiven.report.model.ReportModelVisitor
- visitEnd(ScenarioModel) - Method in class com.tngtech.jgiven.report.text.DataTablePlainTextScenarioWriter
W
- wenn() - Method in class com.tngtech.jgiven.lang.de.EinfacheSzenarioTestBasis
- wenn() - Method in class com.tngtech.jgiven.lang.de.Stufe
- wenn() - Method in class com.tngtech.jgiven.lang.de.SzenarioTestBasis
- when() - Method in class com.tngtech.jgiven.base.ScenarioTestBase
- when() - Method in class com.tngtech.jgiven.Stage
- wire(Object) - Method in interface com.tngtech.jgiven.integration.CanWire
- wireSteps(CanWire) - Method in class com.tngtech.jgiven.base.ScenarioTestBase
- with() - Method in class com.tngtech.jgiven.Stage
- withColor - Variable in class com.tngtech.jgiven.report.text.PlainTextWriter
- withFileName(String) - Method in class com.tngtech.jgiven.attachment.Attachment
-
An optional filename for the attachment without the file type suffix.
- withTitle(String) - Method in class com.tngtech.jgiven.attachment.Attachment
-
Sets the title and returns
this
- Word - Class in com.tngtech.jgiven.report.model
-
Represents a part of a step.
- Word() - Constructor for class com.tngtech.jgiven.report.model.Word
- Word(String) - Constructor for class com.tngtech.jgiven.report.model.Word
- Word(String, boolean) - Constructor for class com.tngtech.jgiven.report.model.Word
- wordToString(Word) - Method in class com.tngtech.jgiven.report.text.DataTablePlainTextScenarioWriter
- wordToString(Word) - Method in class com.tngtech.jgiven.report.text.PlainTextScenarioWriter
- write(ReportModel) - Method in class com.tngtech.jgiven.report.text.PlainTextReporter
- write(File) - Method in class com.tngtech.jgiven.report.json.ScenarioJsonWriter
- writeDataTable(DataTable, String) - Method in class com.tngtech.jgiven.report.text.PlainTextTableWriter
- writer - Variable in class com.tngtech.jgiven.report.text.PlainTextWriter
X
- xml(String) - Static method in class com.tngtech.jgiven.attachment.Attachment
-
Creates a text attachment with the given content with media type text/xml.
- XML_UTF_8 - Static variable in class com.tngtech.jgiven.attachment.MediaType
-
text/xml
Y
$ A B C D E F G H I J K L M N O P Q R S T U V W X YAll Classes and Interfaces|All Packages|Constant Field Values|Serialized Form