|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jbehave.core.reporters.StoryReporterBuilder
public class StoryReporterBuilder
A Builder for
StoryReporter
s. It builds a DelegatingStoryReporter
with
delegates for a number of formats - mostly file-based ones except
. It requires a
FilePrintStreamFactory
and provides default delegate instances for
each format.
To build a reporter for a single story path with default and given formats:
Class<MyStory> storyClass = MyStory.class; StoryPathResolver resolver = new UnderscoredCamelCaseResolver(); String storyPath = resolver.resolve(storyClass); StoryReporter reporter = new StoryReporterBuilder().withCodeLocation(StoryLocation.codeLocationFromClass(storyClass)) .withDefaultFormats().withFormats(TXT, HTML, XML).build(storyPath);
The builder is configured to build with the StoryReporterBuilder.Format.STATS
as default
format. To change the default formats the user can override the method:
new StoryReporterBuilder() { protected StoryReporterBuilder withDefaultFormats() { return withFormats(STATS); } }
The builder configures the file-based reporters to output to the default file
directory FileConfiguration#DIRECTORY
as relative to the code
location. In some case, e.g. with Ant class loader, the code source location
from class may not be properly set. In this case, we may specify it from a
file:
new StoryReporterBuilder().withCodeLocation(StoryLocation.codeLocationFromFile(new File("target/classes"))) .withDefaultFormats().withFormats(TXT, HTML, XML).build(storyPath);
By default, the reporters will output minimal failure information, the single line describing the failure cause and the outcomes if failures occur. To configure the failure trace to be reported as well:
new StoryReporterBuilder().withFailureTrace(true)
If failure trace is reported, it is with the full stack trace. In some cases, it's useful to have it compressed, eliminating unnecessary lines that are not very informative:
new StoryReporterBuilder().withFailureTraceCompression(true)
To specify the use of keywords for a given locale:
new StoryReporterBuilder().withKeywords(new LocalisedKeywords(Locale.IT)
The builder provides default instances for all reporters, using the default output patterns. To change the reporter for a specific instance, e.g. to report format TXT to .text files and to inject other non-default parameters, such as the custom output patterns:
new StoryReporterBuilder(){ public StoryReporter reporterFor(String storyPath, Format format){ FilePrintStreamFactory factory = new FilePrintStreamFactory(new StoryLocation(storyPath, codeLocation)); switch (format) { case TXT: factory.useConfiguration(new FileConfiguration("text")); Properties customPatterns = new Properties(); customPatterns.setProperty("successful", "{0}(YEAH!!!)\n"); return new TxtOutput(factory.createPrintStream(), customPatterns, keywords); default: return super.reporterFor(format); } }
Nested Class Summary | |
---|---|
static class |
StoryReporterBuilder.Format
|
Constructor Summary | |
---|---|
StoryReporterBuilder()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public StoryReporterBuilder()
Method Detail |
---|
public File outputDirectory()
public String relativeDirectory()
public FilePrintStreamFactory.FilePathResolver pathResolver()
public URL codeLocation()
public List<Format> formats()
public List<String> formatNames(boolean toLowerCase)
public Keywords keywords()
public boolean multiThreading()
public boolean reportFailureTrace()
public boolean compressFailureTrace()
public Properties viewResources()
public StoryReporterBuilder withRelativeDirectory(String relativeDirectory)
public StoryReporterBuilder withPathResolver(FilePrintStreamFactory.FilePathResolver pathResolver)
public StoryReporterBuilder withCodeLocation(URL codeLocation)
public CrossReference crossReference()
public boolean hasCrossReference()
public StoryReporterBuilder withCrossReference(CrossReference crossReference)
public StoryReporterBuilder withDefaultFormats()
@Deprecated public StoryReporterBuilder withFormats(StoryReporterBuilder.Format... formats)
withFormats(org.jbehave.core.reporters.Format... formats)
public StoryReporterBuilder withFormats(Format... formats)
public StoryReporterBuilder withFailureTrace(boolean reportFailureTrace)
public StoryReporterBuilder withFailureTraceCompression(boolean compressFailureTrace)
public StoryReporterBuilder withKeywords(Keywords keywords)
public StoryReporterBuilder withMultiThreading(boolean multiThreading)
public StoryReporterBuilder withViewResources(Properties resources)
public StoryReporter build(String storyPath)
public Map<String,StoryReporter> build(List<String> storyPaths)
public StoryReporter reporterFor(String storyPath, StoryReporterBuilder.Format format)
public StoryReporter reporterFor(String storyPath, Format format)
protected FilePrintStreamFactory filePrintStreamFactory(String storyPath)
public FilePrintStreamFactory.FileConfiguration fileConfiguration(String extension)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |