Package ch.ifocusit.livingdoc.plugin.baseMojo

Class AbstractAsciidoctorMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

ch.ifocusit.livingdoc.plugin.baseMojo.AbstractAsciidoctorMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractDocsGeneratorMojo, PublishMojo

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

Author:

Julien Boz

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AbstractAsciidoctorMojo.Format

Field Summary

Fields

Modifier and Type	Field	Description
protected File	generatedDocsDirectory	Directory where the documents will be generated
protected static final String	PLANTUML_MACRO_NAME
protected org.apache.maven.project.MavenProject	project
protected static final String	TEMPLATES_OUTPUT

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

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractAsciidoctorMojo()

Method Summary

Modifier and Type	Method	Description
org.asciidoctor.Asciidoctor	createAsciidoctor()
void	execute()
abstract void	executeMojo()
protected void	extractTemplatesFromJar()
protected File	getOutput(String filename, AbstractAsciidoctorMojo.Format desiredExtension)
protected org.asciidoctor.Options	options()
protected void	write(io.github.robwin.markup.builder.asciidoc.AsciiDocBuilder asciiDocBuilder, AbstractAsciidoctorMojo.Format format, String outputFilename)

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

TEMPLATES_OUTPUT

protected static final String TEMPLATES_OUTPUT

See Also:

• Constant Field Values

PLANTUML_MACRO_NAME

protected static final String PLANTUML_MACRO_NAME

See Also:

• Constant Field Values

project

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
protected org.apache.maven.project.MavenProject project

generatedDocsDirectory

@Parameter(property="livingdoc.output.directory",
           defaultValue="${project.build.directory}/generated-docs",
           required=true)
protected File generatedDocsDirectory

Directory where the documents will be generated

Constructor Details

AbstractAsciidoctorMojo

public AbstractAsciidoctorMojo()

Method Details

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

executeMojo

public abstract void executeMojo()
                          throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

write

protected void write(io.github.robwin.markup.builder.asciidoc.AsciiDocBuilder asciiDocBuilder,
 AbstractAsciidoctorMojo.Format format,
 String outputFilename)
              throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getOutput

protected File getOutput(String filename,
 AbstractAsciidoctorMojo.Format desiredExtension)

createAsciidoctor

public org.asciidoctor.Asciidoctor createAsciidoctor()

options

protected org.asciidoctor.Options options()

extractTemplatesFromJar

protected void extractTemplatesFromJar()