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
FieldsModifier and TypeFieldDescriptionprotected io.github.robwin.markup.builder.asciidoc.AsciiDocBuilderprotected static final Stringprotected com.thoughtworks.qdox.JavaProjectBuilderprotected static final Stringprotected List<DomainObject> protected booleanFields inherited from class ch.ifocusit.livingdoc.plugin.baseMojo.AbstractDocsGeneratorMojo
format, glossaryMapping, onlyAnnotated, packageRoot, repositorySystemFields inherited from class ch.ifocusit.livingdoc.plugin.baseMojo.AbstractAsciidoctorMojo
generatedDocsDirectory, PLANTUML_MACRO_NAME, project, TEMPLATES_OUTPUTFields inherited from interface org.apache.maven.plugin.Mojo
ROLE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected Predicate<com.thoughtworks.qdox.model.JavaClass> protected abstract voidImplementation main method.voidMain method.protected Stream<com.thoughtworks.qdox.model.JavaClass> getMapping(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElement) protected abstract StringgetTitle()protected booleanhasAnnotation(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElement) Methods inherited from class ch.ifocusit.livingdoc.plugin.baseMojo.AbstractDocsGeneratorMojo
appendTitle, appendTitle, createAsciiDocBuilder, getOutputFilename, write, write, writeMethods inherited from class ch.ifocusit.livingdoc.plugin.baseMojo.AbstractAsciidoctorMojo
createAsciidoctor, execute, extractTemplatesFromJar, getOutput, options, writeMethods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Field Details
-
JAVAX_VALIDATION_CONSTRAINTS
- See Also:
-
HIBERNATE_VALIDATION_CONSTRAINTS
- See Also:
-
asciiDocBuilder
protected io.github.robwin.markup.builder.asciidoc.AsciiDocBuilder asciiDocBuilder -
javaDocBuilder
protected com.thoughtworks.qdox.JavaProjectBuilder javaDocBuilder -
mappings
-
somethingWasGenerated
protected boolean somethingWasGenerated
-
-
Constructor Details
-
AbstractGlossaryMojo
public AbstractGlossaryMojo()
-
-
Method Details
-
executeMojo
public void executeMojo() throws org.apache.maven.plugin.MojoExecutionExceptionMain method.- Specified by:
executeMojoin classAbstractAsciidoctorMojo- Throws:
org.apache.maven.plugin.MojoExecutionException
-
getTitle
- Specified by:
getTitlein classAbstractDocsGeneratorMojo- Returns:
- the document title is defined by each mojo
-
executeGlossaryMojo
Implementation main method.- Throws:
Exception
-
getClasses
-
defaultFilter
-
hasAnnotation
protected boolean hasAnnotation(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElement) -
getMapping
public Optional<DomainObject> getMapping(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElement) - Specified by:
getMappingin interfaceMappingRespository
-