Package org.jbehave.core.reporters

Class Format

java.lang.Object

org.jbehave.core.reporters.Format

Direct Known Subclasses:

ContextOutput, StoryReporterBuilder.ProvidedFormat

public abstract class Format
extends Object

A Format is a StoryReporter factory, allowing named-based pre-defined story reporters to be configured via the StoryReporterBuilder.withFormats(Format...) method. Users wanting to configure their custom defined story reporters, can do so via the StoryReporterBuilder.withReporters(StoryReporter...) method, or use the StoryReporterBuilder.ProvidedFormat wrapper.

Field Summary

Fields

Modifier and Type	Field	Description
static Format	ANSI_CONSOLE
static Format	CONSOLE
static Format	HTML
static Format	HTML_TEMPLATE
static Format	IDE_CONSOLE
static Format	JSON
static Format	JSON_TEMPLATE
static Format	STATS	STATS is needed by the final reports.html summary page.
static Format	TEAMCITY_CONSOLE
static Format	TXT
static Format	XML
static Format	XML_TEMPLATE

Constructor Summary

Constructors

Constructor	Description
Format(String name)

Method Summary

Modifier and Type	Method	Description
abstract StoryReporter	createStoryReporter(FilePrintStreamFactory factory, StoryReporterBuilder storyReporterBuilder)
String	name()
static void	println(PrintStream writer, String format, Object... args)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CONSOLE

public static final Format CONSOLE

ANSI_CONSOLE

public static final Format ANSI_CONSOLE

IDE_CONSOLE

public static final Format IDE_CONSOLE

TEAMCITY_CONSOLE

public static final Format TEAMCITY_CONSOLE

TXT

public static final Format TXT

HTML

public static final Format HTML

XML

public static final Format XML

JSON

public static final Format JSON

HTML_TEMPLATE

public static final Format HTML_TEMPLATE

XML_TEMPLATE

public static final Format XML_TEMPLATE

JSON_TEMPLATE

public static final Format JSON_TEMPLATE

STATS

public static final Format STATS

STATS is needed by the final reports.html summary page.

Constructor Detail

Format

public Format(String name)

Method Detail

name

public String name()

createStoryReporter

public abstract StoryReporter createStoryReporter(FilePrintStreamFactory factory,
                                                  StoryReporterBuilder storyReporterBuilder)

println

public static void println(PrintStream writer,
                           String format,
                           Object... args)

toString

public String toString()

Overrides:

toString in class Object