ch.ifocusit.livingdoc.plugin.diagram

Class AbstractClassDiagramBuilder

java.lang.Object

ch.ifocusit.livingdoc.plugin.diagram.AbstractClassDiagramBuilder

All Implemented Interfaces:

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

Direct Known Subclasses:

PlantumlClassDiagramBuilder

public abstract class AbstractClassDiagramBuilder
extends Object
implements ch.ifocusit.plantuml.classdiagram.LinkMaker, ch.ifocusit.plantuml.classdiagram.NamesMapper

Author:

Julien Boz

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	diagramWithDependencies
protected String[]	excludes
protected File	footer
protected File	header
protected String	linkPage
protected ch.ifocusit.plantuml.classdiagram.NamesMapper	namesMapper
protected String	prefix
protected org.apache.maven.project.MavenProject	project

Constructor Summary

Constructors

Constructor and Description
AbstractClassDiagramBuilder(org.apache.maven.project.MavenProject project, String prefix, String[] excludes, File header, File footer, boolean diagramWithDependencies, String linkPage)

Method Summary

Modifier and Type	Method and Description
protected Predicate<com.google.common.reflect.ClassPath.ClassInfo>	defaultFilter()
abstract void	filterOnAnnotation(Class<? extends Annotation> annotation)
abstract String	generate()
Optional<ch.ifocusit.plantuml.classdiagram.model.Link>	getClassLink(Class aClass)
Optional<ch.ifocusit.plantuml.classdiagram.model.Link>	getFieldLink(Field field)
protected com.google.common.reflect.ClassPath	initClassPath()
void	mapNames(File mappings)
protected String	readFooter()
protected String	readHeader()

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

Field Detail

project

protected final org.apache.maven.project.MavenProject project

prefix

protected final String prefix

excludes

protected final String[] excludes

header

protected final File header

footer

protected final File footer

diagramWithDependencies

protected final boolean diagramWithDependencies

linkPage

protected String linkPage

namesMapper

protected ch.ifocusit.plantuml.classdiagram.NamesMapper namesMapper

Constructor Detail

AbstractClassDiagramBuilder

public AbstractClassDiagramBuilder(org.apache.maven.project.MavenProject project,
                                   String prefix,
                                   String[] excludes,
                                   File header,
                                   File footer,
                                   boolean diagramWithDependencies,
                                   String linkPage)

Method Detail

filterOnAnnotation

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

generate

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

Throws:

org.apache.maven.plugin.MojoExecutionException

readHeader

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

Throws:

org.apache.maven.plugin.MojoExecutionException

readFooter

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

Throws:

org.apache.maven.plugin.MojoExecutionException

defaultFilter

protected Predicate<com.google.common.reflect.ClassPath.ClassInfo> defaultFilter()

initClassPath

protected com.google.common.reflect.ClassPath initClassPath()
                                                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

mapNames

public void mapNames(File mappings)
              throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getClassLink

public Optional<ch.ifocusit.plantuml.classdiagram.model.Link> getClassLink(Class aClass)

Specified by:

getClassLink in interface ch.ifocusit.plantuml.classdiagram.LinkMaker

getFieldLink

public Optional<ch.ifocusit.plantuml.classdiagram.model.Link> getFieldLink(Field field)

Specified by:

getFieldLink in interface ch.ifocusit.plantuml.classdiagram.LinkMaker