Package org.apache.camel.quarkus.maven

Class CheckExtensionPagesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.camel.quarkus.maven.AbstractDocGeneratorMojo

org.apache.camel.quarkus.maven.CheckExtensionPagesMojo

All Implemented Interfaces:

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

@Mojo(name="check-extension-pages",
      threadSafe=true)
public class CheckExtensionPagesMojo
extends AbstractDocGeneratorMojo

Performs the following tasks:

• Deletes extension pages whose extensions do not exist anymore
• Creates dummy partials for Camel bits that Camel Quarkus does not support, so that there are no warnings when they are included from the Camel component pages
• Deletes Camel bit partials that do not exist anymore.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) String	camelVersion	The version of Camel we depend on
(package private) File	catalogBaseDir	The directory relative to which the catalog data is read.
(package private) File	docsBaseDir	The path to the docs module base directory
(package private) List<File>	extensionDirectories	List of directories that contain extensions
(package private) String	localRepository
(package private) Set<String>	skipArtifactIdBases	A set of artifactIdBases that are not extensions and should be excluded from the catalog

Fields inherited from class org.apache.camel.quarkus.maven.AbstractDocGeneratorMojo

baseDir, DEFAULT_TEMPLATES_URI_BASE, encoding, multiModuleProjectDirectory, templatesUriBase

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

ROLE

Constructor Summary

Constructors

Constructor	Description
CheckExtensionPagesMojo()

Method Summary

Modifier and Type	Method	Description
(package private) void	camelBits(Path docsBasePath)
void	execute()	Execute goal.
(package private) void	extensions(Path docsBasePath)

Methods inherited from class org.apache.camel.quarkus.maven.AbstractDocGeneratorMojo

evalTemplate

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

catalogBaseDir

@Parameter(defaultValue="${project.build.directory}/classes",
           property="camel-quarkus.catalogBaseDir")
File catalogBaseDir

The directory relative to which the catalog data is read.

docsBaseDir

@Parameter(defaultValue="${maven.multiModuleProjectDirectory}/docs")
File docsBaseDir

The path to the docs module base directory

extensionDirectories

@Parameter(property="cq.extensionDirectories",
           required=true)
List<File> extensionDirectories

List of directories that contain extensions

skipArtifactIdBases

@Parameter(property="cq.skipArtifactIdBases")
Set<String> skipArtifactIdBases

A set of artifactIdBases that are not extensions and should be excluded from the catalog

camelVersion

@Parameter(property="camel.version")
String camelVersion

The version of Camel we depend on

localRepository

@Parameter(defaultValue="${settings.localRepository}",
           readonly=true)
String localRepository

Constructor Detail

CheckExtensionPagesMojo

public CheckExtensionPagesMojo()

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

camelBits

void camelBits(Path docsBasePath)

extensions

void extensions(Path docsBasePath)