org.fulib.tools

Class ClassDiagrams

java.lang.Object

org.fulib.tools.ClassDiagrams

public class ClassDiagrams
extends java.lang.Object

Provides various methods for storing class diagrams as files.

Constructor Summary

Constructors

Constructor and Description
ClassDiagrams()

Method Summary

Modifier and Type	Method and Description
java.lang.String	dump(org.fulib.classmodel.ClassModel model, java.lang.String diagramFileName, guru.nidi.graphviz.engine.Format format) Creates a class diagram of the given class model at the path specified by diagramFileName in the given Graphviz format.
java.lang.String	dumpPng(org.fulib.classmodel.ClassModel model) Create a class diagram of the given class model at the path modelFolder/doc-files/classDiagram.png.
java.lang.String	dumpPng(org.fulib.classmodel.ClassModel model, java.lang.String diagramFileName) Creates a class diagram of the given class model at the path specified by diagramFileName in png format.
java.lang.String	dumpSVG(org.fulib.classmodel.ClassModel model, java.lang.String diagramFileName) Creates a class diagram of the given class model at the path specified by diagramFileName in svg format.
double	getScale()
void	setScale(double scale)
ClassDiagrams	withScale(double scale) Sets the scaling factor to use when rendering (applies to PNG and SVG format).

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassDiagrams

public ClassDiagrams()

Method Detail

getScale

public double getScale()

Returns:

the scale factor for rendering

Since:

1.2

setScale

public void setScale(double scale)

Parameters:

scale - the scale factor for rendering

Since:

1.2

withScale

public ClassDiagrams withScale(double scale)

Sets the scaling factor to use when rendering (applies to PNG and SVG format). Default is 1.

Parameters:

scale - the scaling factor

Returns:

this instance, to allow method chaining

Since:

1.2

dumpPng

public java.lang.String dumpPng(org.fulib.classmodel.ClassModel model)

Create a class diagram of the given class model at the path modelFolder/doc-files/classDiagram.png. in png format.

Parameters:

model - the class model

Returns:

the diagram file name

dumpPng

public java.lang.String dumpPng(org.fulib.classmodel.ClassModel model,
                                java.lang.String diagramFileName)

Creates a class diagram of the given class model at the path specified by diagramFileName in png format.

Parameters:

model - the class model

diagramFileName - the diagram file name

Returns:

the diagram file name

dumpSVG

public java.lang.String dumpSVG(org.fulib.classmodel.ClassModel model,
                                java.lang.String diagramFileName)

Creates a class diagram of the given class model at the path specified by diagramFileName in svg format.

Parameters:

model - the class model

diagramFileName - the diagram file name

Returns:

the diagram file name

dump

public java.lang.String dump(org.fulib.classmodel.ClassModel model,
                             java.lang.String diagramFileName,
                             guru.nidi.graphviz.engine.Format format)

Creates a class diagram of the given class model at the path specified by diagramFileName in the given Graphviz format.

Parameters:

model - the class model

diagramFileName - the diagram file name

format - the file format

Returns:

the diagram file name