Package ch.ifocusit.plantuml.classdiagram

Class ClassDiagramBuilder

java.lang.Object

ch.ifocusit.plantuml.classdiagram.AbstractClassDiagramBuilder

ch.ifocusit.plantuml.classdiagram.ClassDiagramBuilder

All Implemented Interfaces:

LinkMaker, NamesMapper

public class ClassDiagramBuilder
extends AbstractClassDiagramBuilder
implements NamesMapper

Build class diagram from Class definition.

Author:

Julien Boz

Field Summary

Fields inherited from class ch.ifocusit.plantuml.classdiagram.AbstractClassDiagramBuilder

builder, clazzes, detectedAssociations, hideSelfLink, linkMaker, withDependencies

Constructor Summary

Constructors

Constructor	Description
ClassDiagramBuilder()

Method Summary

Modifier and Type	Method	Description
ClassDiagramBuilder	addClasses(Class... classes)
ClassDiagramBuilder	addClasses(Iterable<Class> classes)
ClassDiagramBuilder	addPackage(Package... packages)
void	addPackages()
boolean	canAppearsInDiagram(Class aClass)
ClassAttribute	createClassAttribute(Field field)
ClassMethod	createClassMethod(Method method)
JavaClazz	createJavaClass(Class clazz)
void	detectAssociations()
void	readClasses()
ClassAttribute[]	readFields(Class aClass)
ClassMethod[]	readMethods(Class aClass)
ClassDiagramBuilder	withNamesMapper(NamesMapper namesMapper)
static void	writeDiagramToFile(File file, Class<?>... classes)
static void	writeDiagramToFile(String filename, Class<?>... classes)
static void	writeDiagramToFile(Path path, Class<?>... classes)

Methods inherited from class ch.ifocusit.plantuml.classdiagram.AbstractClassDiagramBuilder

addAssociations, addFieldPredicate, addMethodPredicate, addTypes, build, excludes, filterFields, filterMethods, hideFields, hideMethods, hideSelfLink, setEndOptions, setFooter, setHeader, setStartOptions, setTitle, showSelfLink, withDependencies, withDependencies, withLinkMaker

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

getClassLink, getFieldLink, getMethodLink

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

getClassName, getFieldName, getMethodName

Constructor Details

ClassDiagramBuilder

public ClassDiagramBuilder()

Method Details

writeDiagramToFile

public static void writeDiagramToFile(String filename,
 Class<?>... classes)
                               throws IOException

Throws:

IOException

writeDiagramToFile

public static void writeDiagramToFile(File file,
 Class<?>... classes)
                               throws IOException

Throws:

IOException

writeDiagramToFile

public static void writeDiagramToFile(Path path,
 Class<?>... classes)
                               throws IOException

Throws:

IOException

addClasses

public ClassDiagramBuilder addClasses(Iterable<Class> classes)

addClasses

public ClassDiagramBuilder addClasses(Class... classes)

addPackage

public ClassDiagramBuilder addPackage(Package... packages)

withNamesMapper

public ClassDiagramBuilder withNamesMapper(NamesMapper namesMapper)

addPackages

public void addPackages()

Specified by:

addPackages in class AbstractClassDiagramBuilder

canAppearsInDiagram

public boolean canAppearsInDiagram(Class aClass)

detectAssociations

public void detectAssociations()

Specified by:

detectAssociations in class AbstractClassDiagramBuilder

readClasses

public void readClasses()

Specified by:

readClasses in class AbstractClassDiagramBuilder

createJavaClass

public JavaClazz createJavaClass(Class clazz)

readMethods

public ClassMethod[] readMethods(Class aClass)

createClassMethod

public ClassMethod createClassMethod(Method method)

readFields

public ClassAttribute[] readFields(Class aClass)

createClassAttribute

public ClassAttribute createClassAttribute(Field field)