org.openidentityplatform.doc.maven

Class AbstractAsciidocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.openidentityplatform.doc.maven.AbstractAsciidocMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AntoraMojo, AsciidocPreProcessMojo, AsciidocToPdfMojo

public abstract class AbstractAsciidocMojo
extends org.apache.maven.plugin.AbstractMojo

Field Summary

Fields

Modifier and Type	Field and Description
protected File	buildDirectory The project build directory.
static Set<String>	ignoreFolders
protected org.apache.maven.plugin.BuildPluginManager	pluginManager
protected org.apache.maven.project.MavenProject	project
protected String	projectName Short name of the project, such as OpenAM, OpenDJ, OpenIDM.
protected String	projectVersion Project version.
protected String	releaseVersion Version for this release.
protected org.apache.maven.execution.MavenSession	session The MavenSession object, which is read-only.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractAsciidocMojo()

Method Summary

Modifier and Type	Method and Description
File	getAntoraOutputDirectory() Base directory for built documentation.
protected File	getAsciidocBuildSourceDirectory()
protected File	getAsciidocSourceDirectory()
protected List<String>	getDocuments()

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

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

execute

Field Detail

project

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

session

@Parameter(property="session",
           required=true,
           readonly=true)
protected org.apache.maven.execution.MavenSession session

The MavenSession object, which is read-only.

pluginManager

@Component
protected org.apache.maven.plugin.BuildPluginManager pluginManager

projectName

@Parameter(property="projectName",
           required=true)
protected String projectName

Short name of the project, such as OpenAM, OpenDJ, OpenIDM.

projectVersion

@Parameter(property="projectVersion",
           required=true)
protected String projectVersion

Project version.

releaseVersion

@Parameter(property="releaseVersion",
           required=true)
protected String releaseVersion

Version for this release.

buildDirectory

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

The project build directory.
Default: ${project.build.directory}.

ignoreFolders

public static Set<String> ignoreFolders

Constructor Detail

AbstractAsciidocMojo

public AbstractAsciidocMojo()

Method Detail

getAsciidocSourceDirectory

protected File getAsciidocSourceDirectory()
                                   throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getAsciidocBuildSourceDirectory

protected File getAsciidocBuildSourceDirectory()
                                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getDocuments

protected List<String> getDocuments()
                             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getAntoraOutputDirectory

public File getAntoraOutputDirectory()

Base directory for built documentation.
Value: ${project.build.directory}/antora

Returns:

The base directory for built documentation.