ch.ifocusit.livingdoc.plugin.diagram

Class PlantumlClassDiagramBuilder

java.lang.Object

ch.ifocusit.livingdoc.plugin.diagram.AbstractClassDiagramBuilder

ch.ifocusit.livingdoc.plugin.diagram.PlantumlClassDiagramBuilder

All Implemented Interfaces:

ch.ifocusit.plantuml.classdiagram.LinkMaker, ch.ifocusit.plantuml.classdiagram.NamesMapper

public class PlantumlClassDiagramBuilder
extends AbstractClassDiagramBuilder

Author:

Julien Boz

Field Summary

Fields inherited from class ch.ifocusit.livingdoc.plugin.diagram.AbstractClassDiagramBuilder

diagramWithDependencies, excludes, footer, header, linkPage, namesMapper, prefix, project

Constructor Summary

Constructors

Constructor and Description
PlantumlClassDiagramBuilder(org.apache.maven.project.MavenProject project, String prefix, String[] excludes, String rootAggregateClassMatcher, Color rootAggregateColor, File header, File footer, boolean showMethods, boolean showFields, boolean diagramWithDependencies, String linkPage)

Method Summary

Modifier and Type	Method and Description
void	filterOnAnnotation(Class<? extends Annotation> annotation)
String	generate()
protected String	readHeader()

Methods inherited from class ch.ifocusit.livingdoc.plugin.diagram.AbstractClassDiagramBuilder

defaultFilter, getClassLink, getFieldLink, initClassPath, mapNames, readFooter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ch.ifocusit.plantuml.classdiagram.LinkMaker

getMethodLink

Methods inherited from interface ch.ifocusit.plantuml.classdiagram.NamesMapper

getClassName, getFieldName, getMethodName

Constructor Detail

PlantumlClassDiagramBuilder

public PlantumlClassDiagramBuilder(org.apache.maven.project.MavenProject project,
                                   String prefix,
                                   String[] excludes,
                                   String rootAggregateClassMatcher,
                                   Color rootAggregateColor,
                                   File header,
                                   File footer,
                                   boolean showMethods,
                                   boolean showFields,
                                   boolean diagramWithDependencies,
                                   String linkPage)

Method Detail

generate

public String generate()
                throws org.apache.maven.plugin.MojoExecutionException

Specified by:

generate in class AbstractClassDiagramBuilder

Throws:

org.apache.maven.plugin.MojoExecutionException

readHeader

protected String readHeader()
                     throws org.apache.maven.plugin.MojoExecutionException

Overrides:

readHeader in class AbstractClassDiagramBuilder

Throws:

org.apache.maven.plugin.MojoExecutionException

filterOnAnnotation

public void filterOnAnnotation(Class<? extends Annotation> annotation)

Specified by:

filterOnAnnotation in class AbstractClassDiagramBuilder