Package 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	Description
protected String	diagramTitle
protected boolean	diagramWithDependencies
protected File	endOptions
protected String[]	excludes
protected String	footer
protected String	header
protected String	linkPage
protected ch.ifocusit.plantuml.classdiagram.NamesMapper	namesMapper
protected String	prefix
protected org.apache.maven.project.MavenProject	project
protected String	singleClass
protected File	startOptions

Constructor Summary

Constructors

Constructor	Description
AbstractClassDiagramBuilder()

Method Summary

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

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 Details

project

protected org.apache.maven.project.MavenProject project

prefix

protected String prefix

singleClass

protected String singleClass

excludes

protected String[] excludes

header

protected String header

footer

protected String footer

startOptions

protected File startOptions

endOptions

protected File endOptions

diagramWithDependencies

protected boolean diagramWithDependencies

linkPage

protected String linkPage

diagramTitle

protected String diagramTitle

namesMapper

protected ch.ifocusit.plantuml.classdiagram.NamesMapper namesMapper

Constructor Details

AbstractClassDiagramBuilder

public AbstractClassDiagramBuilder()

Method Details

filterOnAnnotation

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

build

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

Throws:

org.apache.maven.plugin.MojoExecutionException

readStartOptions

protected String[] readStartOptions()
                             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

readEndOptions

protected String[] readEndOptions()
                           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

getClassLoader

protected ClassLoader getClassLoader()
                              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