org.apache.camel.springboot.maven

Class UpdateSpringBootAutoConfigurationReadmeMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.camel.springboot.maven.UpdateSpringBootAutoConfigurationReadmeMojo

All Implemented Interfaces:

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

@Mojo(name="update-spring-boot-auto-configuration-readme",
      threadSafe=true)
public class UpdateSpringBootAutoConfigurationReadmeMojo
extends org.apache.maven.plugin.AbstractMojo

For all the Camel components that has Spring Boot starter JAR, their documentation .adoc files in their component directory is updated to include spring boot auto configuration options.

Field Summary

Fields

Modifier and Type	Field and Description
protected File	buildDir The project build directory
protected Boolean	failFast Whether to fail the build fast if any Warnings was detected.
protected Boolean	failOnMissingDescription Whether to fail if an option has no documentation.
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
UpdateSpringBootAutoConfigurationReadmeMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()

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.

buildDir

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

The project build directory

failFast

@Parameter
protected Boolean failFast

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

failOnMissingDescription

@Parameter
protected Boolean failOnMissingDescription

Whether to fail if an option has no documentation.

Constructor Detail

UpdateSpringBootAutoConfigurationReadmeMojo

public UpdateSpringBootAutoConfigurationReadmeMojo()

Method Detail

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