org.apache.camel.karaf.maven

Class UpdateDocComponentsListMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.camel.karaf.maven.UpdateDocComponentsListMojo

All Implemented Interfaces:

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

@Mojo(name="update-doc-components-list",
      threadSafe=true)
public class UpdateDocComponentsListMojo
extends org.apache.maven.plugin.AbstractMojo

Updates the documentation in: - docs/modules/ROOT/pages/components.adoc to be up to date with all the component starters that Apache Camel Karaf ships.

Field Summary

Fields

Modifier and Type	Field and Description
protected File	componentsDir The directory for components catalog
protected File	dataFormatsDir The directory for data formats catalog
protected File	docBaseDir The website doc base directory
protected File	languagesDir The directory for languages catalog
protected File	othersDir The directory for others catalog
protected org.apache.maven.project.MavenProject	project The maven project.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
UpdateDocComponentsListMojo()

Method Summary

Modifier and Type	Method and Description
void	execute() Execute goal.
protected void	executeComponentsReadme()
protected void	executeDataFormatsReadme()
protected void	executeLanguagesReadme()
protected void	executeOthersReadme()

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 Detail

project

@Parameter(property="project",
           required=true,
           readonly=true)
protected org.apache.maven.project.MavenProject project

The maven project.

componentsDir

@Parameter(defaultValue="${project.build.directory}/classes/org/apache/camel/catalog/karaf/components")
protected File componentsDir

The directory for components catalog

dataFormatsDir

@Parameter(defaultValue="${project.build.directory}/classes/org/apache/camel/catalog/karaf/dataformats")
protected File dataFormatsDir

The directory for data formats catalog

languagesDir

@Parameter(defaultValue="${project.build.directory}/classes/org/apache/camel/catalog/karaf/languages")
protected File languagesDir

The directory for languages catalog

othersDir

@Parameter(defaultValue="${project.build.directory}/classes/org/apache/camel/catalog/karaf/others")
protected File othersDir

The directory for others catalog

docBaseDir

@Parameter(defaultValue="${project.directory}/../../../docs/modules/ROOT/pages")
protected File docBaseDir

The website doc base directory

Constructor Detail

UpdateDocComponentsListMojo

public UpdateDocComponentsListMojo()

Method Detail

execute

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

Execute goal.

Throws:

org.apache.maven.plugin.MojoExecutionException - execution of the main class or one of the threads it generated failed.

org.apache.maven.plugin.MojoFailureException - something bad happened...

executeComponentsReadme

protected void executeComponentsReadme()
                                throws org.apache.maven.plugin.MojoExecutionException,
                                       org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

executeDataFormatsReadme

protected void executeDataFormatsReadme()
                                 throws org.apache.maven.plugin.MojoExecutionException,
                                        org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

executeLanguagesReadme

protected void executeLanguagesReadme()
                               throws org.apache.maven.plugin.MojoExecutionException,
                                      org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

executeOthersReadme

protected void executeOthersReadme()
                            throws org.apache.maven.plugin.MojoExecutionException,
                                   org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException