ch.ifocusit.livingdoc.plugin.baseMojo

Class AbstractDocsGeneratorMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

ch.ifocusit.livingdoc.plugin.baseMojo.AbstractAsciidoctorMojo

ch.ifocusit.livingdoc.plugin.baseMojo.AbstractDocsGeneratorMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractGlossaryMojo, DiagramMojo, GherkinMojo

public abstract class AbstractDocsGeneratorMojo
extends AbstractAsciidoctorMojo

Author:

Julien Boz

Nested Class Summary

Nested classes/interfaces inherited from class ch.ifocusit.livingdoc.plugin.baseMojo.AbstractAsciidoctorMojo

AbstractAsciidoctorMojo.Format

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractAsciidoctorMojo.Format	format Output format of the glossary (default html, others : adoc)
protected File	glossaryMapping File to use for UbiquitousLanguage mapping.
protected boolean	onlyAnnotated Indicate that only annotated classes/fields will be used.
protected String	packageRoot
protected org.apache.maven.repository.RepositorySystem	repositorySystem

Fields inherited from class ch.ifocusit.livingdoc.plugin.baseMojo.AbstractAsciidoctorMojo

generatedDocsDirectory, project, TEMPLATES_OUTPUT

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractDocsGeneratorMojo()

Method Summary

Modifier and Type	Method and Description
protected void	appendTitle(io.github.robwin.markup.builder.asciidoc.AsciiDocBuilder asciiDocBuilder)
protected void	appendTitle(io.github.robwin.markup.builder.asciidoc.AsciiDocBuilder asciiDocBuilder, String title)
protected io.github.robwin.markup.builder.asciidoc.AsciiDocBuilder	createAsciiDocBuilder()
protected abstract String	getOutputFilename()
protected abstract String	getTitle()
protected void	write(io.github.robwin.markup.builder.asciidoc.AsciiDocBuilder asciiDocBuilder) Write asciidoc to defined output in defined format
protected void	write(io.github.robwin.markup.builder.asciidoc.AsciiDocBuilder asciiDocBuilder, String outputFilename)
protected void	write(String newContent, File output) Simple write content to a file.

Methods inherited from class ch.ifocusit.livingdoc.plugin.baseMojo.AbstractAsciidoctorMojo

createAsciidoctor, execute, executeMojo, extractTemplatesFromJar, getOutput, options, write

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

repositorySystem

@Component
protected org.apache.maven.repository.RepositorySystem repositorySystem

packageRoot

@Parameter(property="livingdoc.packageRoot",
           defaultValue="${project.groupId}.${project.artifactId}.domain")
protected String packageRoot

format

@Parameter(property="livingdoc.output.format",
           defaultValue="html")
protected AbstractAsciidoctorMojo.Format format

Output format of the glossary (default html, others : adoc)

glossaryMapping

@Parameter(property="livingdoc.glossary.mapping")
protected File glossaryMapping

File to use for UbiquitousLanguage mapping.

onlyAnnotated

@Parameter(property="livingdoc.onlyAnnotated",
           defaultValue="false")
protected boolean onlyAnnotated

Indicate that only annotated classes/fields will be used.

Constructor Detail

AbstractDocsGeneratorMojo

public AbstractDocsGeneratorMojo()

Method Detail

getOutputFilename

protected abstract String getOutputFilename()

Returns:

the filename is defined by each mojo

getTitle

protected abstract String getTitle()

Returns:

the document title is defined by each mojo

write

protected void write(String newContent,
                     File output)
              throws org.apache.maven.plugin.MojoExecutionException

Simple write content to a file.

Parameters:

newContent - : file content

output - : destination file

Throws:

org.apache.maven.plugin.MojoExecutionException

write

protected void write(io.github.robwin.markup.builder.asciidoc.AsciiDocBuilder asciiDocBuilder)
              throws org.apache.maven.plugin.MojoExecutionException

Write asciidoc to defined output in defined format

Parameters:

asciiDocBuilder - : asciidoc content

Throws:

org.apache.maven.plugin.MojoExecutionException

write

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

Throws:

org.apache.maven.plugin.MojoExecutionException

createAsciiDocBuilder

protected io.github.robwin.markup.builder.asciidoc.AsciiDocBuilder createAsciiDocBuilder()

appendTitle

protected void appendTitle(io.github.robwin.markup.builder.asciidoc.AsciiDocBuilder asciiDocBuilder)

appendTitle

protected void appendTitle(io.github.robwin.markup.builder.asciidoc.AsciiDocBuilder asciiDocBuilder,
                           String title)