org.jbehave.core.embedder
Class Embedder

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

public class Embedder
extends java.lang.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.EnqueuedStory
           
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
 java.util.List<CandidateSteps> candidateSteps()
           
 EmbedderClassLoader classLoader()
           
 Configuration configuration()
           
protected  java.util.concurrent.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, InjectableStepsFactory stepsFactory, BatchFailures batchFailures, MetaFilter filter, java.lang.String storyPath, Story story, StoryRunner.State beforeStories)
           
 java.util.concurrent.Future<Embedder.ThrowableStory> enqueueStory(BatchFailures batchFailures, MetaFilter filter, java.util.List<java.util.concurrent.Future<Embedder.ThrowableStory>> futures, java.lang.String storyPath, Story story)
           
 void generateCrossReference()
           
 void generateReportsView()
           
 void generateReportsView(java.io.File outputDirectory, java.util.List<java.lang.String> formats, java.util.Properties viewResources)
           
 void mapStoriesAsPaths(java.util.List<java.lang.String> storyPaths)
           
 java.util.List<java.lang.String> metaFilters()
           
 void processSystemProperties()
           
 void reportMatchingStepdocs(java.lang.String stepAsString)
           
 void reportStepdocs()
           
 void reportStepdocs(Configuration configuration, java.util.List<CandidateSteps> candidateSteps)
           
 void reportStepdocsAsEmbeddables(java.util.List<java.lang.String> classNames)
           
 void runAsEmbeddables(java.util.List<java.lang.String> classNames)
           
 void runStoriesAsPaths(java.util.List<java.lang.String> storyPaths)
           
 void runStoriesWithAnnotatedEmbedderRunner(java.util.List<java.lang.String> classNames)
           
 InjectableStepsFactory stepsFactory()
           
 StoryRunner storyRunner()
           
 java.util.Properties systemProperties()
           
 java.lang.String toString()
           
 void useCandidateSteps(java.util.List<CandidateSteps> candidateSteps)
           
 void useClassLoader(EmbedderClassLoader classLoader)
           
 void useConfiguration(Configuration configuration)
           
 void useEmbedderControls(EmbedderControls embedderControls)
           
 void useEmbedderMonitor(EmbedderMonitor embedderMonitor)
           
 void useExecutorService(java.util.concurrent.ExecutorService executorService)
           
 void useMetaFilters(java.util.List<java.lang.String> metaFilters)
           
 void useStepsFactory(InjectableStepsFactory stepsFactory)
           
 void useStoryRunner(StoryRunner storyRunner)
           
 void useSystemProperties(java.util.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(java.util.List<java.lang.String> storyPaths)

runAsEmbeddables

public void runAsEmbeddables(java.util.List<java.lang.String> classNames)

runStoriesWithAnnotatedEmbedderRunner

public void runStoriesWithAnnotatedEmbedderRunner(java.util.List<java.lang.String> classNames)

runStoriesAsPaths

public void runStoriesAsPaths(java.util.List<java.lang.String> storyPaths)

enqueueStory

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

enqueuedStory

protected Embedder.EnqueuedStory enqueuedStory(EmbedderControls embedderControls,
                                               Configuration configuration,
                                               InjectableStepsFactory stepsFactory,
                                               BatchFailures batchFailures,
                                               MetaFilter filter,
                                               java.lang.String storyPath,
                                               Story story,
                                               StoryRunner.State beforeStories)

createExecutorService

protected java.util.concurrent.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(java.io.File outputDirectory,
                                java.util.List<java.lang.String> formats,
                                java.util.Properties viewResources)

generateCrossReference

public void generateCrossReference()

reportStepdocs

public void reportStepdocs()

reportStepdocsAsEmbeddables

public void reportStepdocsAsEmbeddables(java.util.List<java.lang.String> classNames)

reportStepdocs

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

reportMatchingStepdocs

public void reportMatchingStepdocs(java.lang.String stepAsString)

processSystemProperties

public void processSystemProperties()

classLoader

public EmbedderClassLoader classLoader()

configuration

public Configuration configuration()

candidateSteps

public java.util.List<CandidateSteps> candidateSteps()

stepsFactory

public InjectableStepsFactory stepsFactory()

embedderControls

public EmbedderControls embedderControls()

embedderMonitor

public EmbedderMonitor embedderMonitor()

metaFilters

public java.util.List<java.lang.String> metaFilters()

storyRunner

public StoryRunner storyRunner()

systemProperties

public java.util.Properties systemProperties()

useClassLoader

public void useClassLoader(EmbedderClassLoader classLoader)

useConfiguration

public void useConfiguration(Configuration configuration)

useCandidateSteps

public void useCandidateSteps(java.util.List<CandidateSteps> candidateSteps)

useStepsFactory

public void useStepsFactory(InjectableStepsFactory stepsFactory)

useEmbedderControls

public void useEmbedderControls(EmbedderControls embedderControls)

useEmbedderMonitor

public void useEmbedderMonitor(EmbedderMonitor embedderMonitor)

useExecutorService

public void useExecutorService(java.util.concurrent.ExecutorService executorService)

useMetaFilters

public void useMetaFilters(java.util.List<java.lang.String> metaFilters)

useStoryRunner

public void useStoryRunner(StoryRunner storyRunner)

useSystemProperties

public void useSystemProperties(java.util.Properties systemProperties)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © 2003-2011. All Rights Reserved.