ch.ifocusit.livingdoc.plugin.baseMojo

Class AbstractGlossaryMojo

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DictionaryMojo, GlossaryMojo

public abstract class AbstractGlossaryMojo
extends AbstractDocsGeneratorMojo
implements MappingRespository

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 io.github.robwin.markup.builder.asciidoc.AsciiDocBuilder	asciiDocBuilder
protected static String	HIBERNATE_VALIDATION_CONSTRAINTS
protected com.thoughtworks.qdox.JavaProjectBuilder	javaDocBuilder
protected static String	JAVAX_VALIDATION_CONSTRAINTS
protected List<DomainObject>	mappings
protected boolean	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, project, TEMPLATES_OUTPUT

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractGlossaryMojo()

Method Summary

Modifier and Type	Method and Description
protected Predicate<com.thoughtworks.qdox.model.JavaClass>	defaultFilter()
protected abstract void	executeGlossaryMojo() Implementation main method.
void	executeMojo() Main method.
protected Stream<com.thoughtworks.qdox.model.JavaClass>	getClasses()
Optional<DomainObject>	getMapping(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElement)
protected abstract String	getTitle()
protected boolean	hasAnnotation(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElement)

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

appendTitle, appendTitle, createAsciiDocBuilder, getOutputFilename, 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

Field Detail

JAVAX_VALIDATION_CONSTRAINTS

protected static final String JAVAX_VALIDATION_CONSTRAINTS

See Also:

Constant Field Values

HIBERNATE_VALIDATION_CONSTRAINTS

protected static final String HIBERNATE_VALIDATION_CONSTRAINTS

See Also:

Constant Field Values

asciiDocBuilder

protected io.github.robwin.markup.builder.asciidoc.AsciiDocBuilder asciiDocBuilder

javaDocBuilder

protected com.thoughtworks.qdox.JavaProjectBuilder javaDocBuilder

mappings

protected List<DomainObject> mappings

somethingWasGenerated

protected boolean somethingWasGenerated

Constructor Detail

AbstractGlossaryMojo

public AbstractGlossaryMojo()

Method Detail

executeMojo

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

Main method.

Specified by:

executeMojo in class AbstractAsciidoctorMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getTitle

protected abstract String getTitle()

Specified by:

getTitle in class AbstractDocsGeneratorMojo

Returns:

the document title is defined by each mojo

executeGlossaryMojo

protected abstract void executeGlossaryMojo()
                                     throws Exception

Implementation main method.

Throws:

Exception

getClasses

protected Stream<com.thoughtworks.qdox.model.JavaClass> getClasses()

defaultFilter

protected Predicate<com.thoughtworks.qdox.model.JavaClass> defaultFilter()

hasAnnotation

protected boolean hasAnnotation(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElement)

getMapping

public Optional<DomainObject> getMapping(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElement)

Specified by:

getMapping in interface MappingRespository