ch.ifocusit.livingdoc.plugin

Class CommonGlossaryMojoDefinition

java.lang.Object

org.apache.maven.plugin.AbstractMojo

ch.ifocusit.livingdoc.plugin.CommonMojoDefinition

ch.ifocusit.livingdoc.plugin.CommonGlossaryMojoDefinition

All Implemented Interfaces:

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

Direct Known Subclasses:

DictionaryMojo, GlossaryMojo

public abstract class CommonGlossaryMojoDefinition
extends CommonMojoDefinition

Author:

Julien Boz

Nested Class Summary

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

CommonMojoDefinition.Format

Field Summary

Fields

Modifier and Type	Field and Description
protected io.github.robwin.markup.builder.asciidoc.AsciiDocBuilder	asciiDocBuilder
protected com.thoughtworks.qdox.JavaProjectBuilder	javaDocBuilder
protected List<MappingDefinition>	mappings

Fields inherited from class ch.ifocusit.livingdoc.plugin.CommonMojoDefinition

format, outputDirectory, outputFilename, project, repositorySystem, template

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

ROLE

Constructor Summary

Constructors

Constructor and Description
CommonGlossaryMojoDefinition()

Method Summary

Modifier and Type	Method and Description
protected String	defaultString(Integer id, String defaultString)
protected static Predicate<MappingDefinition>	distinctByKey()
void	execute()
protected abstract void	executeMojo()
protected Stream<com.thoughtworks.qdox.model.JavaClass>	getClasses()
protected Optional<MappingDefinition>	getDefinition(Optional<Integer> id)
protected String	getDescription(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElemen, String defaultValue)
protected Optional<com.thoughtworks.qdox.model.JavaAnnotation>	getGlossary(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElement)
protected Optional<Integer>	getGlossaryId(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElement)
protected String	getName(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElement, String defaultValue)
protected abstract String	getTitle()
protected boolean	hasAnnotation(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElement)
protected String	idFromName(MappingDefinition def)
protected MappingDefinition	map(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElement, String name, String comment)

Methods inherited from class ch.ifocusit.livingdoc.plugin.CommonMojoDefinition

getDefaultFilename, getFilename, getFilenameWithoutExtension, getOutput

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

asciiDocBuilder

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

javaDocBuilder

protected com.thoughtworks.qdox.JavaProjectBuilder javaDocBuilder

mappings

protected List<MappingDefinition> mappings

Constructor Detail

CommonGlossaryMojoDefinition

public CommonGlossaryMojoDefinition()

Method Detail

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

getTitle

protected abstract String getTitle()

executeMojo

protected abstract void executeMojo()

getClasses

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

hasAnnotation

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

getGlossary

protected Optional<com.thoughtworks.qdox.model.JavaAnnotation> getGlossary(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElement)

getGlossaryId

protected Optional<Integer> getGlossaryId(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElement)

getDefinition

protected Optional<MappingDefinition> getDefinition(Optional<Integer> id)

getName

protected String getName(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElement,
                         String defaultValue)

getDescription

protected String getDescription(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElemen,
                                String defaultValue)

map

protected MappingDefinition map(com.thoughtworks.qdox.model.JavaAnnotatedElement annotatedElement,
                                String name,
                                String comment)

distinctByKey

protected static Predicate<MappingDefinition> distinctByKey()

defaultString

protected String defaultString(Integer id,
                               String defaultString)

idFromName

protected String idFromName(MappingDefinition def)