org.jbehave.core.configuration
Class Configuration

java.lang.Object
  org.jbehave.core.configuration.Configuration

Direct Known Subclasses:

MostUsefulConfiguration, UnmodifiableConfiguration

public class Configuration
extends java.lang.Object

Provides the configuration used by the Embedder and the in the RunnableStory implementations to customise its runtime properties.

Configuration implements a Builder pattern so that each element of the configuration can be specified individually, and read well. All elements have default values, which can be overridden by the "use" methods. The "use" methods allow to override the dependencies one by one and play nicer with a Java hierarchical structure, in that does allow the use of non-static member variables.

Constructor Summary

Configuration()

Method Summary

CandidateStepFinder	candidateStepFinder()
CandidateStepReporter	candidateStepReporter()
StoryReporter	defaultStoryReporter()
void	doDryRun(boolean dryRun)
boolean	dryRun()
EmbedderControls	embedderControls()
FailureStrategy	failureStrategy()
Keywords	keywords()
ParameterConverters	parameterConverters()
com.thoughtworks.paranamer.Paranamer	paranamer()
PendingStepStrategy	pendingStepStrategy()
StepCollector	stepCollector()
StepdocGenerator	stepdocGenerator()
StepdocReporter	stepdocReporter()
StepMonitor	stepMonitor()
StepPatternParser	stepPatternParser()
StoryLoader	storyLoader()
StoryParser	storyParser()
StoryPathResolver	storyPathResolver()
StoryReporter	storyReporter(java.lang.String storyPath)
StoryReporterBuilder	storyReporterBuilder()
java.lang.String	toString()
void	useCandidateStepFinder(CandidateStepFinder candidateStepFinder)
void	useCandidateStepReporter(CandidateStepReporter candidateStepReporter)
Configuration	useDefaultStoryReporter(StoryReporter storyReporter)
Configuration	useEmbedderControls(EmbedderControls embedderControls)
Configuration	useFailureStrategy(FailureStrategy failureStrategy)
Configuration	useKeywords(Keywords keywords)
Configuration	useParameterConverters(ParameterConverters parameterConverters)
Configuration	useParanamer(com.thoughtworks.paranamer.Paranamer paranamer)
Configuration	usePendingStepStrategy(PendingStepStrategy pendingStepStrategy)
Configuration	useStepCollector(StepCollector stepCollector)
void	useStepdocGenerator(StepdocGenerator stepdocGenerator)
void	useStepdocReporter(StepdocReporter stepdocReporter)
Configuration	useStepMonitor(StepMonitor stepMonitor)
Configuration	useStepPatternParser(StepPatternParser stepPatternParser)
Configuration	useStoryLoader(StoryLoader storyLoader)
Configuration	useStoryParser(StoryParser storyParser)
Configuration	useStoryPathResolver(StoryPathResolver storyPathResolver)
Configuration	useStoryReporter(java.lang.String storyPath, StoryReporter storyReporter)
Configuration	useStoryReporterBuilder(StoryReporterBuilder storyReporterBuilder)
Configuration	useStoryReporters(java.util.Map<java.lang.String,StoryReporter> storyReporters)
void	useViewGenerator(ViewGenerator viewGenerator)
ViewGenerator	viewGenerator()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Configuration

public Configuration()

Method Detail

candidateStepFinder

public CandidateStepFinder candidateStepFinder()

candidateStepReporter

public CandidateStepReporter candidateStepReporter()

dryRun

public boolean dryRun()

keywords

public Keywords keywords()

stepCollector

public StepCollector stepCollector()

storyParser

public StoryParser storyParser()

storyLoader

public StoryLoader storyLoader()

storyPathResolver

public StoryPathResolver storyPathResolver()

failureStrategy

public FailureStrategy failureStrategy()

pendingStepStrategy

public PendingStepStrategy pendingStepStrategy()

defaultStoryReporter

public StoryReporter defaultStoryReporter()

storyReporter

public StoryReporter storyReporter(java.lang.String storyPath)

storyReporterBuilder

public StoryReporterBuilder storyReporterBuilder()

stepPatternParser

public StepPatternParser stepPatternParser()

stepMonitor

public StepMonitor stepMonitor()

paranamer

public com.thoughtworks.paranamer.Paranamer paranamer()

parameterConverters

public ParameterConverters parameterConverters()

stepdocGenerator

public StepdocGenerator stepdocGenerator()

stepdocReporter

public StepdocReporter stepdocReporter()

viewGenerator

public ViewGenerator viewGenerator()

embedderControls

public EmbedderControls embedderControls()

useCandidateStepFinder

public void useCandidateStepFinder(CandidateStepFinder candidateStepFinder)

useCandidateStepReporter

public void useCandidateStepReporter(CandidateStepReporter candidateStepReporter)

doDryRun

public void doDryRun(boolean dryRun)

useKeywords

public Configuration useKeywords(Keywords keywords)

useStepCollector

public Configuration useStepCollector(StepCollector stepCollector)

usePendingStepStrategy

public Configuration usePendingStepStrategy(PendingStepStrategy pendingStepStrategy)

useFailureStrategy

public Configuration useFailureStrategy(FailureStrategy failureStrategy)

useStoryParser

public Configuration useStoryParser(StoryParser storyParser)

useStoryLoader

public Configuration useStoryLoader(StoryLoader storyLoader)

useStoryPathResolver

public Configuration useStoryPathResolver(StoryPathResolver storyPathResolver)

useDefaultStoryReporter

public Configuration useDefaultStoryReporter(StoryReporter storyReporter)

useStoryReporter

public Configuration useStoryReporter(java.lang.String storyPath,
                                      StoryReporter storyReporter)

useStoryReporters

public Configuration useStoryReporters(java.util.Map<java.lang.String,StoryReporter> storyReporters)

useStoryReporterBuilder

public Configuration useStoryReporterBuilder(StoryReporterBuilder storyReporterBuilder)

useEmbedderControls

public Configuration useEmbedderControls(EmbedderControls embedderControls)

useStepPatternParser

public Configuration useStepPatternParser(StepPatternParser stepPatternParser)

useStepMonitor

public Configuration useStepMonitor(StepMonitor stepMonitor)

useParanamer

public Configuration useParanamer(com.thoughtworks.paranamer.Paranamer paranamer)

useParameterConverters

public Configuration useParameterConverters(ParameterConverters parameterConverters)

useStepdocGenerator

public void useStepdocGenerator(StepdocGenerator stepdocGenerator)

useStepdocReporter

public void useStepdocReporter(StepdocReporter stepdocReporter)

useViewGenerator

public void useViewGenerator(ViewGenerator viewGenerator)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object