Package org.apache.camel.maven.packaging

Class PrepareCamelJBangDocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.camel.maven.packaging.AbstractGeneratorMojo

org.apache.camel.maven.packaging.PrepareCamelJBangDocMojo

All Implemented Interfaces:

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

@Mojo(name="prepare-jbang-doc",
      defaultPhase=PROCESS_CLASSES,
      threadSafe=true,
      requiresDependencyResolution=COMPILE)
public class PrepareCamelJBangDocMojo
extends AbstractGeneratorMojo

Prepares camel-jbang by updating the jbang documentation.

Field Summary

Fields

Modifier and Type	Field	Description
protected File	docDocDir	The documentation directory
protected File	jbangJsonFile	The metadata file

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
PrepareCamelJBangDocMojo(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, newTreeMap, 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

docDocDir

@Parameter(defaultValue="${project.basedir}/../../../docs/user-manual/modules/ROOT/pages")
protected File docDocDir

The documentation directory

jbangJsonFile

@Parameter(defaultValue="${project.basedir}/src/generated/resources/META-INF/camel-jbang-configuration-metadata.json")
protected File jbangJsonFile

The metadata file

Constructor Details

PrepareCamelJBangDocMojo

@Inject
public PrepareCamelJBangDocMojo(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,
org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException