Package org.l2x6.cq.maven.doc

Class UpdateDocPageMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.l2x6.cq.maven.doc.UpdateDocPageMojo

All Implemented Interfaces:

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

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

Updates the given extension's documentation page in the docs module based on data in the current module.

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 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
UpdateDocPageMojo()

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()
static String	extensionName(Function<String,String> getProperty, Supplier<String> getName)
static String	extensionName(org.apache.maven.model.Model project)
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 Detail

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 Detail

UpdateDocPageMojo

public UpdateDocPageMojo()

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

extensionName

public static String extensionName(org.apache.maven.model.Model project)

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()