ch.ifocusit.livingdoc.plugin.diagram

Class AbstractClassDiagramBuilder

java.lang.Object

ch.ifocusit.livingdoc.plugin.diagram.AbstractClassDiagramBuilder

Direct Known Subclasses:

PlantumlClassDiagramBuilder

public abstract class AbstractClassDiagramBuilder
extends Object

Author:

Julien Boz

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	excludes
protected File	footer
protected File	header
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)

Method Summary

Modifier and Type	Method and Description
protected Predicate<com.google.common.reflect.ClassPath.ClassInfo>	defaultFilter()
abstract AbstractClassDiagramBuilder	filterOnAnnotation(Class<? extends Annotation> annotation)
abstract String	generate()
protected com.google.common.reflect.ClassPath	initClassPath()
protected String	read(File file)
protected String	readFooter()
protected String	readHeader()

Methods inherited from class java.lang.Object

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

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

Constructor Detail

AbstractClassDiagramBuilder

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

Method Detail

filterOnAnnotation

public abstract AbstractClassDiagramBuilder 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

read

protected String read(File file)
               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