java.lang.Object

org.concordion.internal.ConcordionBuilder

All Implemented Interfaces:: ConcordionExtender

public class ConcordionBuilder extends Object implements ConcordionExtender

Field Summary

Fields

Modifier and Type

Field

Description

static final String

NAMESPACE_CONCORDION_2007
Constructor Summary

Constructors

Constructor

Description

ConcordionBuilder()
Method Summary

Modifier and Type

Method

Description

Concordion

build()

Concordion

build(boolean fullBuild)

static File

getBaseOutputDir()

ConcordionBuilder

withAssertEqualsListener(AssertEqualsListener listener)

Adds a listener to concordion:assertEquals commands.

ConcordionBuilder

withAssertFalseListener(AssertFalseListener listener)

Adds a listener to concordion:assertFalse commands.

ConcordionBuilder

withAssertTrueListener(AssertTrueListener listener)

Adds a listener to concordion:assertTrue commands.

ConcordionBuilder

withBreadcrumbRenderer(BreadcrumbRenderer breadcrumbRenderer)

Overrides the listener for rendering bread crumbs.

ConcordionBuilder

withBuildListener(ConcordionBuildListener listener)

Adds a listener that is invoked when a Concordion instance is built, providing access to the Target to which resources can be written.

ConcordionBuilder

withCommand(String namespaceURI, String commandName, Command command)

Adds a command to Concordion.

ConcordionBuilder

withDocumentParsingListener(DocumentParsingListener listener)

Adds a listener that is invoked when Concordion parses the specification document, providing access to the parsed document.

ConcordionBuilder

withEmbeddedCSS(String css)

Embeds the given CSS in the Concordion output.

ConcordionBuilder

withEmbeddedCSS(String css, boolean append)

Embeds the given CSS in the Concordion output.

ConcordionBuilder

withEmbeddedJavaScript(String javaScript)

Embeds the given JavaScript in the Concordion output.

ConcordionBuilder

withEvaluatorFactory(EvaluatorFactory evaluatorFactory)

ConcordionExtender

withExampleListener(ExampleListener listener)

Adds a listener that is invoked before and after Concordion has processed the example, providing access to the example node.

ConcordionBuilder

withExecuteListener(ExecuteListener listener)

Adds a listener to concordion:execute commands.

ConcordionBuilder

withFailFast(Class<? extends Throwable>[] failFastExceptions)

ConcordionBuilder

withFixture(Fixture fixture)

ConcordionBuilder

withFixtureType(FixtureType fixtureType)

ConcordionExtender

withImplementationStatusModifier(ImplementationStatusModifier statusModifier)

Adds a status modifier which Concordion can apply to each specification example to override their status.

ConcordionBuilder

withLinkedCSS(String cssPath, Resource targetResource)

Copies the given CSS file to the Concordion output folder, and adds a link to the CSS in the <head> section of the Concordion HTML.

ConcordionBuilder

withLinkedJavaScript(String jsPath, Resource targetResource)

Copies the given JavaScript file to the Concordion output folder, and adds a link to the JavaScript in the <head> section of the Concordion HTML.

ConcordionExtender

withOuterExampleListener(OuterExampleListener listener)

Adds a listener that is invoked before and after Concordion has processed the "outer" example (which includes all commands in a specification not inside an example command).

ConcordionBuilder

withPageFooterRenderer(SpecificationProcessingListener pageFooterRenderer)

ConcordionBuilder

withResource(String sourcePath, Resource targetResource)

Copies a resource to the Concordion output.

ConcordionBuilder

withRunListener(RunListener listener)

Adds a listener to concordion:run commands.

ConcordionBuilder

withRunnerFactory(RunnerFactory runnerFactory)

ConcordionExtender

withRunStrategy(RunStrategy runStrategy)

Sets the strategy for the RunCommand.

ConcordionExtender

withSetListener(SetListener setListener)

Adds a listener to concordion:set commands.

ConcordionBuilder

withSource(Source source)

Overrides the source that the Concordion specifications are read from.

ConcordionBuilder

withSource(Source source, SourceType sourceType)

ConcordionBuilder

withSpecificationLocator(SpecificationLocator specificationLocator)

Overrides the locator for Concordion specifications.

ConcordionBuilder

withSpecificationProcessingListener(SpecificationProcessingListener listener)

Adds a listener that is invoked before and after Concordion has processed the specification, providing access to the specification resource and root element.

ConcordionBuilder

withSpecificationType(String typeSuffix, SpecificationConverter converter)

Adds a new specification type to the types that can be handled (by default HTML and Markdown are supported).

ConcordionBuilder

withTarget(Target target)

Overrides the target that the Concordion specifications are written to.

ConcordionBuilder

withThrowableListener(ThrowableCaughtListener throwableListener)

Adds a listener that is invoked when an uncaught Throwable is thrown by a command, including commands that have been added using ConcordionExtender.withCommand(String, String, Command).

ConcordionBuilder

withVerifyRowsListener(VerifyRowsListener listener)

Adds a listener to concordion:verifyRows commands.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- NAMESPACE_CONCORDION_2007
  
  public static final String NAMESPACE_CONCORDION_2007
  See Also:
  
  Constant Field Values
Constructor Details
- ConcordionBuilder
  
  public ConcordionBuilder()
Method Details
- withSource
  
  public ConcordionBuilder withSource(Source source)
  
  Description copied from interface: ConcordionExtender
  
  Overrides the source that the Concordion specifications are read from.
  
  Specified by:
  
  withSource in interface ConcordionExtender
  
  Parameters:
  
  source - the new source
  
  Returns:
  
  this
- withSource
  
  public ConcordionBuilder withSource(Source source, SourceType sourceType)
- withTarget
  
  public ConcordionBuilder withTarget(Target target)
  
  Description copied from interface: ConcordionExtender
  
  Overrides the target that the Concordion specifications are written to.
  
  Specified by:
  
  withTarget in interface ConcordionExtender
  
  Parameters:
  
  target - the new target
  
  Returns:
  
  this
- withPageFooterRenderer
  
  public ConcordionBuilder withPageFooterRenderer(SpecificationProcessingListener pageFooterRenderer)
- withBreadcrumbRenderer
  
  public ConcordionBuilder withBreadcrumbRenderer(BreadcrumbRenderer breadcrumbRenderer)
  
  Description copied from interface: ConcordionExtender
  
  Overrides the listener for rendering bread crumbs.
  
  Specified by:
  
  withBreadcrumbRenderer in interface ConcordionExtender
  
  Parameters:
  
  breadcrumbRenderer - the new bread crumb renderer
  
  Returns:
  
  this
- withRunnerFactory
  
  public ConcordionBuilder withRunnerFactory(RunnerFactory runnerFactory)
- withSpecificationLocator
  
  public ConcordionBuilder withSpecificationLocator(SpecificationLocator specificationLocator)
  
  Description copied from interface: ConcordionExtender
  
  Overrides the locator for Concordion specifications.
  
  Specified by:
  
  withSpecificationLocator in interface ConcordionExtender
  
  Parameters:
  
  specificationLocator - the new specification locator
  
  Returns:
  
  this
- withEvaluatorFactory
  
  public ConcordionBuilder withEvaluatorFactory(EvaluatorFactory evaluatorFactory)
- withThrowableListener
  
  public ConcordionBuilder withThrowableListener(ThrowableCaughtListener throwableListener)
  
  Description copied from interface: ConcordionExtender
  
  Adds a listener that is invoked when an uncaught Throwable is thrown by a command, including commands that have been added using ConcordionExtender.withCommand(String, String, Command).
  
  Specified by:
  
  withThrowableListener in interface ConcordionExtender
  
  Parameters:
  
  throwableListener - the listener
  
  Returns:
  
  this
- withAssertEqualsListener
  
  public ConcordionBuilder withAssertEqualsListener(AssertEqualsListener listener)
  
  Description copied from interface: ConcordionExtender
  
  Adds a listener to concordion:assertEquals commands.
  
  Specified by:
  
  withAssertEqualsListener in interface ConcordionExtender
  
  Parameters:
  
  listener - the listener
  
  Returns:
  
  this
- withAssertTrueListener
  
  public ConcordionBuilder withAssertTrueListener(AssertTrueListener listener)
  
  Description copied from interface: ConcordionExtender
  
  Adds a listener to concordion:assertTrue commands.
  
  Specified by:
  
  withAssertTrueListener in interface ConcordionExtender
  
  Parameters:
  
  listener - the listener
  
  Returns:
  
  this
- withAssertFalseListener
  
  public ConcordionBuilder withAssertFalseListener(AssertFalseListener listener)
  
  Description copied from interface: ConcordionExtender
  
  Adds a listener to concordion:assertFalse commands.
  
  Specified by:
  
  withAssertFalseListener in interface ConcordionExtender
  
  Parameters:
  
  listener - the listener
  
  Returns:
  
  this
- withVerifyRowsListener
  
  public ConcordionBuilder withVerifyRowsListener(VerifyRowsListener listener)
  
  Description copied from interface: ConcordionExtender
  
  Adds a listener to concordion:verifyRows commands.
  
  Specified by:
  
  withVerifyRowsListener in interface ConcordionExtender
  
  Parameters:
  
  listener - the listener
  
  Returns:
  
  this
- withRunListener
  
  public ConcordionBuilder withRunListener(RunListener listener)
  
  Description copied from interface: ConcordionExtender
  
  Adds a listener to concordion:run commands.
  
  Specified by:
  
  withRunListener in interface ConcordionExtender
  
  Parameters:
  
  listener - the listener
  
  Returns:
  
  this
- withRunStrategy
  
  public ConcordionExtender withRunStrategy(RunStrategy runStrategy)
  
  Description copied from interface: ConcordionExtender
  
  Sets the strategy for the RunCommand.
  
  Specified by:
  
  withRunStrategy in interface ConcordionExtender
  
  Parameters:
  
  runStrategy - the new strategy for running the specifications
  
  Returns:
  
  this
- withExecuteListener
  
  public ConcordionBuilder withExecuteListener(ExecuteListener listener)
  
  Description copied from interface: ConcordionExtender
  
  Adds a listener to concordion:execute commands.
  
  Specified by:
  
  withExecuteListener in interface ConcordionExtender
  
  Parameters:
  
  listener - the listener
  
  Returns:
  
  this
- withSetListener
  
  public ConcordionExtender withSetListener(SetListener setListener)
  
  Description copied from interface: ConcordionExtender
  
  Adds a listener to concordion:set commands.
  
  Specified by:
  
  withSetListener in interface ConcordionExtender
  
  Parameters:
  
  setListener - the listener
  
  Returns:
  
  this
- withDocumentParsingListener
  
  public ConcordionBuilder withDocumentParsingListener(DocumentParsingListener listener)
  
  Description copied from interface: ConcordionExtender
  
  Adds a listener that is invoked when Concordion parses the specification document, providing access to the parsed document.
  
  Specified by:
  
  withDocumentParsingListener in interface ConcordionExtender
  
  Parameters:
  
  listener - the listener
  
  Returns:
  
  this
- withSpecificationProcessingListener
  
  public ConcordionBuilder withSpecificationProcessingListener(SpecificationProcessingListener listener)
  
  Description copied from interface: ConcordionExtender
  
  Adds a listener that is invoked before and after Concordion has processed the specification, providing access to the specification resource and root element.
  
  Specified by:
  
  withSpecificationProcessingListener in interface ConcordionExtender
  
  Parameters:
  
  listener - the listener
  
  Returns:
  
  this
- withBuildListener
  
  public ConcordionBuilder withBuildListener(ConcordionBuildListener listener)
  
  Description copied from interface: ConcordionExtender
  
  Adds a listener that is invoked when a Concordion instance is built, providing access to the Target to which resources can be written.
  
  Specified by:
  
  withBuildListener in interface ConcordionExtender
  
  Parameters:
  
  listener - the listener
  
  Returns:
  
  this
- withCommand
  
  public ConcordionBuilder withCommand(String namespaceURI, String commandName, Command command)
  
  Description copied from interface: ConcordionExtender
  
  Adds a command to Concordion.
  
  Specified by:
  
  withCommand in interface ConcordionExtender
  
  Parameters:
  
  namespaceURI - the URI to be used for the namespace of the command. Must not be concordion.org.
  
  commandName - the name to be used for the command. The fully qualified name composed of the namespaceURI and commandName must be used to reference the command in the Concordion specification.
  
  command - the command to be executed
  
  Returns:
  
  this
- withResource
  
  public ConcordionBuilder withResource(String sourcePath, Resource targetResource)
  
  Description copied from interface: ConcordionExtender
  
  Copies a resource to the Concordion output.
  
  Specified by:
  
  withResource in interface ConcordionExtender
  
  Parameters:
  
  sourcePath - Storage Path
  
  targetResource - Target Resource
  
  Returns:
  
  this
- withEmbeddedCSS
  
  public ConcordionBuilder withEmbeddedCSS(String css)
  
  Description copied from interface: ConcordionExtender
  
  Embeds the given CSS in the Concordion output.
  
  Specified by:
  
  withEmbeddedCSS in interface ConcordionExtender
  
  Parameters:
  
  css - CSS
  
  Returns:
  
  this
- withEmbeddedCSS
  
  public ConcordionBuilder withEmbeddedCSS(String css, boolean append)
  
  Description copied from interface: ConcordionExtender
  
  Embeds the given CSS in the Concordion output.
  
  Specified by:
  
  withEmbeddedCSS in interface ConcordionExtender
  
  Parameters:
  
  css - CSS
  
  append - if true appends as last element in head section, else inserts as first element
  
  Returns:
  
  this
- withLinkedCSS
  
  public ConcordionBuilder withLinkedCSS(String cssPath, Resource targetResource)
  
  Description copied from interface: ConcordionExtender
  
  Copies the given CSS file to the Concordion output folder, and adds a link to the CSS in the <head> section of the Concordion HTML.
  
  Specified by:
  
  withLinkedCSS in interface ConcordionExtender
  
  Parameters:
  
  cssPath - CSS Path
  
  targetResource - Target Resource
  
  Returns:
  
  this
- withEmbeddedJavaScript
  
  public ConcordionBuilder withEmbeddedJavaScript(String javaScript)
  
  Description copied from interface: ConcordionExtender
  
  Embeds the given JavaScript in the Concordion output.
  
  Specified by:
  
  withEmbeddedJavaScript in interface ConcordionExtender
  
  Parameters:
  
  javaScript - javaScript
  
  Returns:
  
  this
- withLinkedJavaScript
  
  public ConcordionBuilder withLinkedJavaScript(String jsPath, Resource targetResource)
  
  Description copied from interface: ConcordionExtender
  
  Copies the given JavaScript file to the Concordion output folder, and adds a link to the JavaScript in the <head> section of the Concordion HTML.
  
  Specified by:
  
  withLinkedJavaScript in interface ConcordionExtender
  
  Parameters:
  
  jsPath - path to javascript
  
  targetResource - target resource
  
  Returns:
  
  this
- build
  
  public Concordion build() throws UnableToBuildConcordionException
  
  Throws:
  
  UnableToBuildConcordionException
- build
  
  public Concordion build(boolean fullBuild) throws UnableToBuildConcordionException
  
  Throws:
  
  UnableToBuildConcordionException
- getBaseOutputDir
  
  public static File getBaseOutputDir()
- withFailFast
  
  public ConcordionBuilder withFailFast(Class<? extends Throwable>[] failFastExceptions)
- withFixtureType
  
  public ConcordionBuilder withFixtureType(FixtureType fixtureType)
- withFixture
  
  public ConcordionBuilder withFixture(Fixture fixture)
- withExampleListener
  
  public ConcordionExtender withExampleListener(ExampleListener listener)
  
  Description copied from interface: ConcordionExtender
  
  Adds a listener that is invoked before and after Concordion has processed the example, providing access to the example node.
  
  Specified by:
  
  withExampleListener in interface ConcordionExtender
  
  Parameters:
  
  listener - the listener
  
  Returns:
  
  this
- withImplementationStatusModifier
  
  public ConcordionExtender withImplementationStatusModifier(ImplementationStatusModifier statusModifier)
  
  Description copied from interface: ConcordionExtender
  
  Adds a status modifier which Concordion can apply to each specification example to override their status.
  
  Specified by:
  
  withImplementationStatusModifier in interface ConcordionExtender
  
  Parameters:
  
  statusModifier - the status modifier
  
  Returns:
  
  this
- withOuterExampleListener
  
  public ConcordionExtender withOuterExampleListener(OuterExampleListener listener)
  
  Description copied from interface: ConcordionExtender
  
  Adds a listener that is invoked before and after Concordion has processed the "outer" example (which includes all commands in a specification not inside an example command).
  
  Specified by:
  
  withOuterExampleListener in interface ConcordionExtender
  
  Parameters:
  
  listener - the listener
  
  Returns:
  
  this
- withSpecificationType
  
  public ConcordionBuilder withSpecificationType(String typeSuffix, SpecificationConverter converter)
  
  Description copied from interface: ConcordionExtender
  
  Adds a new specification type to the types that can be handled (by default HTML and Markdown are supported).
  
  Specified by:
  
  withSpecificationType in interface ConcordionExtender
  
  Parameters:
  
  typeSuffix - the suffix of the file type to map this to
  
  converter - converts the specification to HTML format
  
  Returns:
  
  this

Class ConcordionBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

NAMESPACE_CONCORDION_2007

Constructor Details

ConcordionBuilder

Method Details

withSource

withSource

withTarget

withPageFooterRenderer

withBreadcrumbRenderer

withRunnerFactory

withSpecificationLocator

withEvaluatorFactory

withThrowableListener

withAssertEqualsListener

withAssertTrueListener

withAssertFalseListener

withVerifyRowsListener

withRunListener

withRunStrategy

withExecuteListener

withSetListener

withDocumentParsingListener

withSpecificationProcessingListener

withBuildListener

withCommand

withResource

withEmbeddedCSS

withEmbeddedCSS

withLinkedCSS

withEmbeddedJavaScript

withLinkedJavaScript

build

build

getBaseOutputDir

withFailFast

withFixtureType

withFixture

withExampleListener

withImplementationStatusModifier

withOuterExampleListener

withSpecificationType