Package org.apache.camel.maven.packaging

Class PrepareExampleMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.camel.maven.packaging.PrepareExampleMojo

All Implemented Interfaces:

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

@Mojo(name="prepare-example",
      threadSafe=true)
public class PrepareExampleMojo
extends org.apache.maven.plugin.AbstractMojo

Prepares the readme.md files content up to date with all the examples that Apache Camel ships.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	filter
protected String	filterMiddleFolder
protected org.apache.maven.project.MavenProject	project	The maven project.
protected String	startingFolder

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

ROLE

Constructor Summary

Constructors

Constructor	Description
PrepareExampleMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()	Execute goal.
protected void	executeExamplesReadme()

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

project

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

The maven project.

startingFolder

@Parameter(property="startingFolder",
           required=true,
           readonly=true,
           defaultValue="examples")
protected String startingFolder

filter

@Parameter(property="filter",
           required=true,
           readonly=true,
           defaultValue="camel-example")
protected String filter

filterMiddleFolder

@Parameter(property="filterMiddleFolder",
           required=false,
           readonly=true)
protected String filterMiddleFolder

Constructor Details

PrepareExampleMojo

public PrepareExampleMojo()

Method Details

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...

executeExamplesReadme

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException