Package org.l2x6.cq.maven.doc

Class UpdateDocsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.l2x6.cq.maven.doc.UpdateDocsMojo

All Implemented Interfaces:

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

@Mojo(name="update-docs",
      threadSafe=true)
public class UpdateDocsMojo
extends org.apache.maven.plugin.AbstractMojo

Performs the following tasks:

• Deletes extension pages whose extensions do not exist anymore
• Synchronizes nav.adoc with the reality

Intended primarily for Quarkiverse CXF. Note that there is a similar plugin in Camel Quarkus.

Since:

3.4.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_TEMPLATES_URI_BASE
protected File	docsBaseDir	The path to the docs module base directory

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

ROLE

Constructor Summary

Constructors

Constructor	Description
UpdateDocsMojo()

Method Summary

Modifier and Type	Method	Description
protected static <T extends Writer> T	evalTemplate(freemarker.template.Configuration cfg, String templateUri, Map<String,Object> model, T out)
void	execute()	Execute goal.
static String	extensionName(Function<String,String> getProperty, Supplier<String> getName)
protected Charset	getCharset()
Path	getMultiModuleProjectDirectoryPath()

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

DEFAULT_TEMPLATES_URI_BASE

public static final String DEFAULT_TEMPLATES_URI_BASE

See Also:

• Constant Field Values

docsBaseDir

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

The path to the docs module base directory

Since:

3.4.0

Constructor Details

UpdateDocsMojo

public UpdateDocsMojo()

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

evalTemplate

protected static <T extends Writer> T evalTemplate(freemarker.template.Configuration cfg,
 String templateUri,
 Map<String,Object> model,
 T out)

getCharset

protected Charset getCharset()

extensionName

public static String extensionName(Function<String,String> getProperty,
 Supplier<String> getName)

getMultiModuleProjectDirectoryPath

public Path getMultiModuleProjectDirectoryPath()