Package org.citrusframework.mvn.plugin

Class CreateDocsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.citrusframework.mvn.plugin.AbstractCitrusMojo

org.citrusframework.mvn.plugin.CreateDocsMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="create-docs")
public class CreateDocsMojo
extends AbstractCitrusMojo

Creates test documentation in interactive mode. Either uses mode excel for MS Excel output or html for HTML web page output.

Since:

2.7.4

Author:

Christoph Deppisch

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	skipCreateDocs

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
CreateDocsMojo()	Default constructor.
CreateDocsMojo(ExcelTestDocsGenerator excelTestDocsGenerator, HtmlTestDocsGenerator htmlTestDocsGenerator)	Constructor using final fields.

Method Summary

Modifier and Type	Method	Description
void	doExecute()	Subclass execution logic.
ExcelTestDocsGenerator	getExcelTestDocsGenerator()	Gets the excelTestDocsGenerator.
HtmlTestDocsGenerator	getHtmlTestDocsGenerator()	Gets the htmlTestDocsGenerator.
void	setPrompter(org.codehaus.plexus.components.interactivity.Prompter prompter)	Sets the prompter.

Methods inherited from class org.citrusframework.mvn.plugin.AbstractCitrusMojo

execute, getDocs, getFramework, getTests, getTestSrcDirectory, getType, setDocs, setTests, setType

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Details

skipCreateDocs

@Parameter(property="citrus.skip.create.docs",
           defaultValue="false")
protected boolean skipCreateDocs

Constructor Details

CreateDocsMojo

public CreateDocsMojo()

Default constructor.

CreateDocsMojo

public CreateDocsMojo(ExcelTestDocsGenerator excelTestDocsGenerator,
 HtmlTestDocsGenerator htmlTestDocsGenerator)

Constructor using final fields.

Parameters:

excelTestDocsGenerator -

htmlTestDocsGenerator -

Method Details

doExecute

public void doExecute()
               throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: AbstractCitrusMojo

Subclass execution logic.

Specified by:

doExecute in class AbstractCitrusMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

getHtmlTestDocsGenerator

public HtmlTestDocsGenerator getHtmlTestDocsGenerator()

Gets the htmlTestDocsGenerator.

Returns:

getExcelTestDocsGenerator

public ExcelTestDocsGenerator getExcelTestDocsGenerator()

Gets the excelTestDocsGenerator.

Returns:

setPrompter

public void setPrompter(org.codehaus.plexus.components.interactivity.Prompter prompter)

Sets the prompter.

Parameters:

prompter - the prompter to set