Package ch.ifocusit.livingdoc.plugin

Class DictionaryMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

ch.ifocusit.livingdoc.plugin.baseMojo.AbstractAsciidoctorMojo

ch.ifocusit.livingdoc.plugin.baseMojo.AbstractDocsGeneratorMojo

ch.ifocusit.livingdoc.plugin.baseMojo.AbstractGlossaryMojo

ch.ifocusit.livingdoc.plugin.DictionaryMojo

All Implemented Interfaces:

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

@Mojo(name="dictionary",
      requiresDependencyResolution=RUNTIME_PLUS_SYSTEM,
      defaultPhase=PROCESS_CLASSES)
public class DictionaryMojo
extends AbstractGlossaryMojo

Glossary of domain objects in a title/content representation.

Author:

Julien Boz

Nested Class Summary

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

AbstractAsciidoctorMojo.Format

Field Summary

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

asciiDocBuilder, HIBERNATE_VALIDATION_CONSTRAINTS, javaDocBuilder, JAVAX_VALIDATION_CONSTRAINTS, mappings, somethingWasGenerated

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

format, glossaryMapping, onlyAnnotated, packageRoot, repositorySystem

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

generatedDocsDirectory, PLANTUML_MACRO_NAME, project, TEMPLATES_OUTPUT

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

ROLE

Constructor Summary

Constructors

Constructor	Description
DictionaryMojo()

Method Summary

Modifier and Type	Method	Description
protected void	executeGlossaryMojo()	Implementation main method.
protected String	getOutputFilename()
protected String	getTitle()

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

defaultFilter, executeMojo, getClasses, getMapping, hasAnnotation

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

appendTitle, appendTitle, createAsciiDocBuilder, write, write, write

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

createAsciidoctor, execute, 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

Constructor Details

DictionaryMojo

public DictionaryMojo()

Method Details

getOutputFilename

protected String getOutputFilename()

Specified by:

getOutputFilename in class AbstractDocsGeneratorMojo

Returns:

the filename is defined by each mojo

getTitle

protected String getTitle()

Specified by:

getTitle in class AbstractGlossaryMojo

Returns:

the document title is defined by each mojo

executeGlossaryMojo

protected void executeGlossaryMojo()
                            throws Exception

Description copied from class: AbstractGlossaryMojo

Implementation main method.

Specified by:

executeGlossaryMojo in class AbstractGlossaryMojo

Throws:

Exception