Package org.jbehave.core.embedder

Class Embedder

java.lang.Object

org.jbehave.core.embedder.Embedder

public class Embedder
extends Object

The Embedder is a facade allowing all functionality to be embedded into other run contexts, such as IDEs (e.g. via JUnit support) or CLIs (via Ant or Maven).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Embedder.AnnotatedEmbedderRunFailed
static interface	Embedder.EmbedderFailureStrategy
static class	Embedder.RunningEmbeddablesFailed
static class	Embedder.RunningStoriesFailed
static class	Embedder.ThrowingRunningStoriesFailed
static class	Embedder.ViewGenerationFailed

Field Summary

Fields

Modifier and Type	Field	Description
protected EmbedderClassLoader	classLoader
protected Configuration	configuration
protected EmbedderControls	embedderControls
protected Embedder.EmbedderFailureStrategy	embedderFailureStrategy
protected EmbedderMonitor	embedderMonitor
protected ExecutorService	executorService
protected boolean	executorServiceCreated
protected List<String>	metaFilters
protected Map<String,MetaFilter.MetaMatcher>	metaMatchers
protected PerformableTree	performableTree
protected InjectableStepsFactory	stepsFactory
protected StoryManager	storyManager
protected StoryMapper	storyMapper
protected Properties	systemProperties
protected StoryTimeouts.TimeoutParser[]	timeoutParsers

Constructor Summary

Constructors

Constructor	Description
Embedder()
Embedder(EmbedderMonitor embedderMonitor)
Embedder(StoryMapper storyMapper, PerformableTree performableTree, EmbedderMonitor embedderMonitor)

Method Summary

Modifier and Type	Method	Description
EmbedderClassLoader	classLoader()
Configuration	configuration()
protected void	configureThreads(Configuration configuration, int threads)
EmbedderControls	embedderControls()
Embedder.EmbedderFailureStrategy	embedderFailureStrategy()
EmbedderMonitor	embedderMonitor()
ExecutorService	executorService()
void	generateReportsView()
void	generateReportsView(File outputDirectory, List<String> formats, Properties viewResources)
void	generateSurefireReport()
boolean	hasExecutorService()
void	mapStoriesAsPaths(List<String> storyPaths)
MetaFilter	metaFilter()
List<String>	metaFilters()
Map<String,MetaFilter.MetaMatcher>	metaMatchers()
PerformableTree	performableTree()
void	processSystemProperties()
void	reportMatchingStepdocs(String stepAsString)
void	reportStepdocs()
void	reportStepdocs(Configuration configuration, List<CandidateSteps> candidateSteps)
void	reportStepdocsAsEmbeddables(List<String> classNames)
void	runAsEmbeddables(List<String> classNames)
void	runStoriesAsPaths(List<String> storyPaths)
void	runStoriesWithAnnotatedEmbedderRunner(List<String> classNames)
protected void	shutdownExecutorService()	Shuts down executor service, if it was created by Embedder.
InjectableStepsFactory	stepsFactory()
StoryManager	storyManager()
Properties	systemProperties()
StoryTimeouts.TimeoutParser[]	timeoutParsers()
String	toString()
void	useClassLoader(EmbedderClassLoader classLoader)
void	useConfiguration(Configuration configuration)
void	useEmbedderControls(EmbedderControls embedderControls)
void	useEmbedderFailureStrategy(Embedder.EmbedderFailureStrategy failureStategy)
void	useEmbedderMonitor(EmbedderMonitor embedderMonitor)
void	useExecutorService(ExecutorService executorService)
void	useMetaFilters(List<String> metaFilters)
void	useMetaMatchers(Map<String,MetaFilter.MetaMatcher> metaMatchers)
void	usePerformableTree(PerformableTree performableTree)
void	useStepsFactory(InjectableStepsFactory stepsFactory)
void	useSystemProperties(Properties systemProperties)
void	useTimeoutParsers(StoryTimeouts.TimeoutParser... timeoutParsers)

Methods inherited from class java.lang.Object

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

Field Details

storyMapper

protected StoryMapper storyMapper

embedderMonitor

protected EmbedderMonitor embedderMonitor

classLoader

protected EmbedderClassLoader classLoader

embedderControls

protected EmbedderControls embedderControls

embedderFailureStrategy

protected Embedder.EmbedderFailureStrategy embedderFailureStrategy

configuration

protected Configuration configuration

stepsFactory

protected InjectableStepsFactory stepsFactory

metaFilters

protected List<String> metaFilters

metaMatchers

protected Map<String,MetaFilter.MetaMatcher> metaMatchers

systemProperties

protected Properties systemProperties

executorService

protected ExecutorService executorService

executorServiceCreated

protected boolean executorServiceCreated

performableTree

protected PerformableTree performableTree

storyManager

protected StoryManager storyManager

timeoutParsers

protected StoryTimeouts.TimeoutParser[] timeoutParsers

Constructor Details

Embedder

public Embedder()

Embedder

public Embedder(EmbedderMonitor embedderMonitor)

Embedder

public Embedder(StoryMapper storyMapper,
 PerformableTree performableTree,
 EmbedderMonitor embedderMonitor)

Method Details

mapStoriesAsPaths

public void mapStoriesAsPaths(List<String> storyPaths)

runAsEmbeddables

public void runAsEmbeddables(List<String> classNames)

runStoriesWithAnnotatedEmbedderRunner

public void runStoriesWithAnnotatedEmbedderRunner(List<String> classNames)

runStoriesAsPaths

public void runStoriesAsPaths(List<String> storyPaths)

generateReportsView

public void generateReportsView()

generateReportsView

public void generateReportsView(File outputDirectory,
 List<String> formats,
 Properties viewResources)

generateSurefireReport

public void generateSurefireReport()

reportStepdocs

public void reportStepdocs()

reportStepdocs

public void reportStepdocs(Configuration configuration,
 List<CandidateSteps> candidateSteps)

reportStepdocsAsEmbeddables

public void reportStepdocsAsEmbeddables(List<String> classNames)

reportMatchingStepdocs

public void reportMatchingStepdocs(String stepAsString)

processSystemProperties

public void processSystemProperties()

classLoader

public EmbedderClassLoader classLoader()

configuration

public Configuration configuration()

stepsFactory

public InjectableStepsFactory stepsFactory()

embedderControls

public EmbedderControls embedderControls()

embedderMonitor

public EmbedderMonitor embedderMonitor()

embedderFailureStrategy

public Embedder.EmbedderFailureStrategy embedderFailureStrategy()

hasExecutorService

public boolean hasExecutorService()

executorService

public ExecutorService executorService()

shutdownExecutorService

protected void shutdownExecutorService()

Shuts down executor service, if it was created by Embedder. ExecutorServices provided by the useExecutorService(ExecutorService) need to be managed by the provider.

storyManager

public StoryManager storyManager()

configureThreads

protected void configureThreads(Configuration configuration,
 int threads)

metaFilters

public List<String> metaFilters()

metaMatchers

public Map<String,MetaFilter.MetaMatcher> metaMatchers()

metaFilter

public MetaFilter metaFilter()

performableTree

public PerformableTree performableTree()

systemProperties

public Properties systemProperties()

timeoutParsers

public StoryTimeouts.TimeoutParser[] timeoutParsers()

useClassLoader

public void useClassLoader(EmbedderClassLoader classLoader)

useConfiguration

public void useConfiguration(Configuration configuration)

useStepsFactory

public void useStepsFactory(InjectableStepsFactory stepsFactory)

useEmbedderControls

public void useEmbedderControls(EmbedderControls embedderControls)

useEmbedderFailureStrategy

public void useEmbedderFailureStrategy(Embedder.EmbedderFailureStrategy failureStategy)

useEmbedderMonitor

public void useEmbedderMonitor(EmbedderMonitor embedderMonitor)

useExecutorService

public void useExecutorService(ExecutorService executorService)

useMetaFilters

public void useMetaFilters(List<String> metaFilters)

useMetaMatchers

public void useMetaMatchers(Map<String,MetaFilter.MetaMatcher> metaMatchers)

usePerformableTree

public void usePerformableTree(PerformableTree performableTree)

useSystemProperties

public void useSystemProperties(Properties systemProperties)

useTimeoutParsers

public void useTimeoutParsers(StoryTimeouts.TimeoutParser... timeoutParsers)

toString

public String toString()

Overrides:

toString in class Object