org.jbehave.core.embedder
Class Embedder

java.lang.Object
  extended by org.jbehave.core.embedder.Embedder

public class Embedder
extends Object

Represents an entry point to all of JBehave's functionality that is embeddable into other launchers, such as IDEs or CLIs.


Nested Class Summary
static class Embedder.AnnotatedEmbedderRunFailed
           
static class Embedder.AnnotatedEmbedderRunnerInstantiationFailed
           
static class Embedder.ClassLoadingFailed
           
static class Embedder.EnqueuedStory
           
static class Embedder.NonThreadingExecutorService
          Non-threading ExecutorService for situations where thread count = 1
static class Embedder.RunningEmbeddablesFailed
           
static class Embedder.RunningStoriesFailed
           
static class Embedder.ThrowableStory
           
static class Embedder.ViewGenerationFailed
           
 
Constructor Summary
Embedder()
           
Embedder(StoryMapper storyMapper, StoryRunner storyRunner, EmbedderMonitor embedderMonitor)
           
 
Method Summary
 List<CandidateSteps> candidateSteps()
           
 EmbedderClassLoader classLoader()
           
 Configuration configuration()
           
protected  ExecutorService createExecutorService()
          Creates a ThreadPoolExecutor using the number of threads defined in the EmbedderControls.threads()
 EmbedderControls embedderControls()
           
 EmbedderMonitor embedderMonitor()
           
protected  Embedder.EnqueuedStory enqueuedStory(EmbedderControls embedderControls, Configuration configuration, List<CandidateSteps> candidateSteps, BatchFailures batchFailures, MetaFilter filter, String storyPath, Story story)
           
 Future<Embedder.ThrowableStory> enqueueStory(BatchFailures batchFailures, MetaFilter filter, List<Future<Embedder.ThrowableStory>> futures, String storyPath, Story story)
           
 void generateCrossReference()
           
 void generateReportsView()
           
 void generateReportsView(File outputDirectory, List<String> formats, Properties viewResources)
           
 void mapStoriesAsPaths(List<String> storyPaths)
           
 List<String> metaFilters()
           
 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(String runnerClass, List<String> classNames)
           
 StoryRunner storyRunner()
           
 Properties systemProperties()
           
 String toString()
           
 void useCandidateSteps(List<CandidateSteps> candidateSteps)
           
 void useClassLoader(EmbedderClassLoader classLoader)
           
 void useConfiguration(Configuration configuration)
           
 void useEmbedderControls(EmbedderControls embedderControls)
           
 void useEmbedderMonitor(EmbedderMonitor embedderMonitor)
           
 void useMetaFilters(List<String> metaFilters)
           
 void useStoryRunner(StoryRunner storyRunner)
           
 void useSystemProperties(Properties systemProperties)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Embedder

public Embedder()

Embedder

public Embedder(StoryMapper storyMapper,
                StoryRunner storyRunner,
                EmbedderMonitor embedderMonitor)
Method Detail

mapStoriesAsPaths

public void mapStoriesAsPaths(List<String> storyPaths)

runAsEmbeddables

public void runAsEmbeddables(List<String> classNames)

runStoriesWithAnnotatedEmbedderRunner

public void runStoriesWithAnnotatedEmbedderRunner(String runnerClass,
                                                  List<String> classNames)

runStoriesAsPaths

public void runStoriesAsPaths(List<String> storyPaths)

enqueueStory

public Future<Embedder.ThrowableStory> enqueueStory(BatchFailures batchFailures,
                                                    MetaFilter filter,
                                                    List<Future<Embedder.ThrowableStory>> futures,
                                                    String storyPath,
                                                    Story story)

enqueuedStory

protected Embedder.EnqueuedStory enqueuedStory(EmbedderControls embedderControls,
                                               Configuration configuration,
                                               List<CandidateSteps> candidateSteps,
                                               BatchFailures batchFailures,
                                               MetaFilter filter,
                                               String storyPath,
                                               Story story)

createExecutorService

protected ExecutorService createExecutorService()
Creates a ThreadPoolExecutor using the number of threads defined in the EmbedderControls.threads()

Returns:
An ExecutorService

generateReportsView

public void generateReportsView()

generateReportsView

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

generateCrossReference

public void generateCrossReference()

reportStepdocs

public void reportStepdocs()

reportStepdocsAsEmbeddables

public void reportStepdocsAsEmbeddables(List<String> classNames)

reportStepdocs

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

reportMatchingStepdocs

public void reportMatchingStepdocs(String stepAsString)

processSystemProperties

public void processSystemProperties()

classLoader

public EmbedderClassLoader classLoader()

configuration

public Configuration configuration()

candidateSteps

public List<CandidateSteps> candidateSteps()

embedderControls

public EmbedderControls embedderControls()

embedderMonitor

public EmbedderMonitor embedderMonitor()

metaFilters

public List<String> metaFilters()

storyRunner

public StoryRunner storyRunner()

systemProperties

public Properties systemProperties()

useClassLoader

public void useClassLoader(EmbedderClassLoader classLoader)

useConfiguration

public void useConfiguration(Configuration configuration)

useCandidateSteps

public void useCandidateSteps(List<CandidateSteps> candidateSteps)

useEmbedderControls

public void useEmbedderControls(EmbedderControls embedderControls)

useEmbedderMonitor

public void useEmbedderMonitor(EmbedderMonitor embedderMonitor)

useMetaFilters

public void useMetaFilters(List<String> metaFilters)

useStoryRunner

public void useStoryRunner(StoryRunner storyRunner)

useSystemProperties

public void useSystemProperties(Properties systemProperties)

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2003-2011. All Rights Reserved.