Package org.jbehave.core.steps

Interface Summary

Interface	Description
CandidateSteps	Interface providing the list of step candidates, representing methods annotated with @Given, @When or @Then that can be matched.
InjectableStepsFactory	Interface abstracting the creation of CandidateSteps.
ParameterConverters.ParameterConverter<S,T>	A parameter converter for generic type of source input and target output.
Parameters	Provides parameter values as given types
Row	Represents a row in an ExamplesTable.
Step	A Step represents a runnable portion of a Scenario, which matches methods annotated in CandidateSteps instances.
StepCollector	Represents the strategy for the collection of executable Steps from a story or scenario matching a list of StepCandidates.
StepFinder.PrioritisingStrategy	Defines the priorising strategy of step candidates
StepMonitor	Interface to monitor step events
StepResult

Class Summary

Class	Description
AbstractCandidateSteps
AbstractStepResult	Represents the possible step results: Failed NotPerformed Pending Successful Ignorable Skipped
AbstractStepResult.Comment
AbstractStepResult.Failed
AbstractStepResult.Ignorable
AbstractStepResult.NotPerformed
AbstractStepResult.Pending
AbstractStepResult.Skipped
AbstractStepResult.Successful
AbstractStepsFactory	An abstract implementation of InjectableStepsFactory that is provided by concrete subclasses Object instances which contain the candidate steps methods.
BeforeOrAfterStep	A BeforeOrAfterStep is associated to a Java method annotated with BeforeStory, AfterStory, BeforeScenario or AfterScenario in a CandidateSteps instance class.
ChainedRow	Implementation of Row that chains delegate Rows in resolving requests for values.
CompositeCandidateSteps
CompositeStepsFactory	An InjectableStepsFactory that composes CandidateSteps created from other factories.
ConditionalStepCandidate
ContextStepMonitor	Decorator of StepMonitor which shows the current context via the ContextView.
ConvertedParameters	Implementation of Parameters that uses ParameterConverters to convert values.
DelegatingStepMonitor	Monitor which collects other StepMonitors and delegates all invocations to the collected monitors.
InstanceStepsFactory	An InjectableStepsFactory that is provided Object instances.
MarkUnmatchedStepsAsPending	StepCollector that marks unmatched steps as AbstractStepResult.Pending.
NullStepMonitor	Null Object Pattern implementation of StepMonitor.
ParameterControls
ParameterConverters	Facade responsible for converting parameter values to Java objects.
ParameterConverters.AbstractListParameterConverter<T>
ParameterConverters.AbstractParameterConverter<S,T>
ParameterConverters.BooleanConverter
ParameterConverters.BooleanListConverter
ParameterConverters.DateConverter	Parses value to a Date using an injectable DateFormat (defaults to new SimpleDateFormat("dd/MM/yyyy"))
ParameterConverters.EnumConverter	Parses value to any Enum
ParameterConverters.EnumListConverter	Parses value to list of the same Enum, using an injectable value separator (defaults to ",") and trimming each element of the list.
ParameterConverters.ExamplesTableConverter	Converts value to ExamplesTable using a ExamplesTableFactory.
ParameterConverters.ExamplesTableParametersConverter	Converts ExamplesTable to list of parameters, mapped to annotated custom types.
ParameterConverters.FluentEnumConverter	An ParameterConverters.EnumConverter allowing stories prose to be more natural.
ParameterConverters.FromStringParameterConverter<T>
ParameterConverters.FunctionalParameterConverter<S,T>
ParameterConverters.JsonConverter
ParameterConverters.JsonFactory
ParameterConverters.MethodReturningConverter	Invokes method on instance to return value.
ParameterConverters.NumberConverter	Converts values to numbers, supporting any subclass of Number (including generic Number type), and it unboxed counterpart, using a NumberFormat to parse to a Number and to convert it to a specific number type: Byte, byte: Number.byteValue() Short, short: Number.shortValue() Integer, int: Number.intValue() Float, float: Number.floatValue() Long, long: Number.longValue() Double, double: Number.doubleValue() BigInteger: BigInteger.valueOf(long) BigDecimal: BigDecimal.valueOf(double) If no number format is provided, it defaults to NumberFormat.getInstance().
ParameterConverters.NumberListConverter	Converts value to list of numbers.
ParameterConverters.StringConverter
ParameterConverters.StringListConverter	Converts value to list of String.
PatternVariantBuilder	Builds a set of pattern variants of given pattern input, supporting a custom directives.
PendingStepMethodGenerator
PrintingStepMonitor	Abstract StepMonitor that prints to output which should be defined in child implementations.
PrintStreamStepMonitor	StepMonitor that prints to a PrintStream, defaulting to System.out.
ProvidedStepsFactory	An InjectableStepsFactory that is provided with the CandidateSteps instances.
ScanningStepsFactory	An InjectableStepsFactory that scans for classes in the classpath.
SilentStepMonitor	StepMonitor that prints nothings.
StepCandidate	A StepCandidate is associated to a Java method annotated with Given, When, Then in a steps instance class.
StepCreator
StepCreator.AbstractStep
StepCreator.Comment
StepCreator.IgnorableStep
StepCreator.Jsr330Helper	This is a different class, because the @Inject jar may not be in the classpath.
StepCreator.PendingStep
StepCreator.ReportingAbstractStep
Stepdoc	A Stepdoc represents the documentation on a single StepCandidate, which includes: the step type the pattern to match the step candidate that is configured in the annotation the method in the steps instance class the steps instance class
StepFinder	StepFinder is reponsible for finding and prioritising step candidates or finding steps instances from CandidateSteps, which are created using an InjectableStepsFactory.
StepFinder.ByLevenshteinDistance	Strategy to priorise candidate steps by Levenshtein Distance
StepFinder.ByPriorityField	Strategy to priorise step candidates by the StepCandidate.getPriority() field which is settable in the Given, When, Then annotations.
Steps	Default implementation of CandidateSteps which provides the step candidates that match the steps being run.
Timer
Timing

Enum Summary

Enum	Description
StepCollector.Stage
StepCreator.StepExecutionType
StepResult.Type
StepType	Enum representing the step types

Exception Summary

Exception	Description
AbstractStepsFactory.StepsInstanceNotFound
ConvertedParameters.ParametersNotMappableToType
ConvertedParameters.ValueNotFound
ParameterConverters.ParameterConversionFailed
StepCreator.ParameterNotFound