Package ch.ifocusit.livingdoc.plugin

Class DiagramMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

ch.ifocusit.livingdoc.plugin.baseMojo.AbstractAsciidoctorMojo

ch.ifocusit.livingdoc.plugin.baseMojo.AbstractDocsGeneratorMojo

ch.ifocusit.livingdoc.plugin.DiagramMojo

All Implemented Interfaces:

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

@Mojo(name="diagram",
      requiresDependencyResolution=RUNTIME_PLUS_SYSTEM,
      defaultPhase=PROCESS_CLASSES)
public class DiagramMojo
extends AbstractDocsGeneratorMojo

Author:

Julien Boz

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DiagramMojo.DiagramImageType
static enum	DiagramMojo.DiagramType

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

AbstractAsciidoctorMojo.Format

Field Summary

Fields

Modifier and Type	Field	Description
protected String	singleClassAndDependencies	Generate a diagram based on a single class (full name) and all his dependencies.

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
DiagramMojo()

Method Summary

Modifier and Type	Method	Description
void	executeMojo()
protected String	getOutputFilename()
protected String	getTitle()
DiagramMojo	setDiagramTitle(String diagramTitle)
DiagramMojo	setDiagramType(DiagramMojo.DiagramType diagramType)

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

Field Details

singleClassAndDependencies

@Parameter(property="livingdoc.diagram.singleClassAndDependencies")
protected String singleClassAndDependencies

Generate a diagram based on a single class (full name) and all his dependencies.

Constructor Details

DiagramMojo

public DiagramMojo()

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 AbstractDocsGeneratorMojo

Returns:

the document title is defined by each mojo

executeMojo

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

Specified by:

executeMojo in class AbstractAsciidoctorMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

setDiagramTitle

public DiagramMojo setDiagramTitle(String diagramTitle)

setDiagramType

public DiagramMojo setDiagramType(DiagramMojo.DiagramType diagramType)