Package org.apache.camel.maven.packaging

Class UpdateReadmeMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.camel.maven.packaging.AbstractGeneratorMojo

org.apache.camel.maven.packaging.UpdateReadmeMojo

All Implemented Interfaces:

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

@Mojo(name="update-readme",
      threadSafe=true)
public class UpdateReadmeMojo
extends AbstractGeneratorMojo

Generate or updates the component/dataformat/language/eip documentation .adoc files in the project src/main/docs directory.

Field Summary

Fields

Modifier and Type	Field	Description
protected File	buildDir	The project build directory
protected File	componentDocDir	The component documentation directory
protected File	dataformatDocDir	The dataformat documentation directory
protected File	eipDocDir	The EIP documentation directory
protected Boolean	failFast	Whether to fail the build fast if any Warnings was detected.
protected File	languageDocDir	The language documentation directory
protected File	languageDocDir2	The other language documentation directory
protected List<Path>	sourceRoots

Fields inherited from class org.apache.camel.maven.packaging.AbstractGeneratorMojo

buildContext, GENERATED_MSG, NL, project, projectHelper

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

ROLE

Constructor Summary

Constructors

Constructor	Description
UpdateReadmeMojo(org.apache.maven.project.MavenProjectHelper projectHelper, org.codehaus.plexus.build.BuildContext buildContext)

Method Summary

Modifier and Type	Method	Description
void	execute()
void	execute(org.apache.maven.project.MavenProject project)

Methods inherited from class org.apache.camel.maven.packaging.AbstractGeneratorMojo

addResourceDirectory, cache, canonicalClassName, createProperties, createProperties, findConfigurations, format, getProjectClassLoader, haveResourcesChanged, isJsonFile, loadClass, newTreeSet, refresh, refresh, updateResource, updateResource, velocity

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

buildDir

@Parameter(defaultValue="${project.build.directory}")
protected File buildDir

The project build directory

componentDocDir

@Parameter(defaultValue="${project.basedir}/src/main/docs")
protected File componentDocDir

The component documentation directory

dataformatDocDir

@Parameter(defaultValue="${project.basedir}/src/main/docs")
protected File dataformatDocDir

The dataformat documentation directory

languageDocDir

@Parameter(defaultValue="${project.basedir}/src/main/docs")
protected File languageDocDir

The language documentation directory

languageDocDir2

@Parameter(defaultValue="${project.basedir}/src/main/docs/modules/languages/pages")
protected File languageDocDir2

The other language documentation directory

eipDocDir

@Parameter
protected File eipDocDir

The EIP documentation directory

failFast

@Parameter
protected Boolean failFast

Whether to fail the build fast if any Warnings was detected.

sourceRoots

protected List<Path> sourceRoots

Constructor Details

UpdateReadmeMojo

@Inject
public UpdateReadmeMojo(org.apache.maven.project.MavenProjectHelper projectHelper,
 org.codehaus.plexus.build.BuildContext buildContext)

Method Details

execute

public void execute(org.apache.maven.project.MavenProject project)
             throws org.apache.maven.plugin.MojoFailureException,
org.apache.maven.plugin.MojoExecutionException

Overrides:

execute in class AbstractGeneratorMojo

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException