org.fulib.tools

Class ObjectDiagrams

java.lang.Object

org.fulib.tools.ObjectDiagrams

public class ObjectDiagrams
extends java.lang.Object

Create object diagrams.

 
 FulibTools.objectDiagrams().dumpPng("../fulib/doc/images/studyRightObjects.png", studyRight);
 
 

Example:

Constructor Summary

Constructors

Constructor and Description
ObjectDiagrams()

Method Summary

Modifier and Type	Method and Description
java.lang.String	dumpPng(java.lang.Object... objectList) create an object diagram png in tmp/TheFirstObjectsClass.1.png Example:
java.lang.String	dumpPng(java.lang.String diagramFileName, java.lang.Object... objectList) Create object diagrams.
java.lang.String	dumpSVG(java.lang.String diagramFileName, java.lang.Object... objectList) Create object diagrams.
java.lang.String	dumpYaml(java.lang.String diagramFileName, java.lang.Object... objectList) Create yaml description.
double	getScale()
void	setScale(double scale)
ObjectDiagrams	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

ObjectDiagrams

public ObjectDiagrams()

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 ObjectDiagrams 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(java.lang.Object... objectList)

create an object diagram png in tmp/TheFirstObjectsClass.1.png
Example:

Parameters:

objectList - the list of objects to display

Returns:

the file name

dumpPng

public java.lang.String dumpPng(java.lang.String diagramFileName,
                                java.lang.Object... objectList)

Create object diagrams.

 
 FulibTools.objectDiagrams().dumpPng("../fulib/doc/images/studyRightObjects.png", studyRight);
 
 

Example:

Parameters:

diagramFileName - the file name in which the diagram should be saved

objectList - the list of objects to display

Returns:

the file name (= diagramFileName), for compatibility with dumpPng(Object...)

dumpSVG

public java.lang.String dumpSVG(java.lang.String diagramFileName,
                                java.lang.Object... objectList)

Create object diagrams.

 
 FulibTools.objectDiagrams().dumpPng("../fulib/doc/images/studyRightObjects.png", studyRight);
 
 

Example:

Parameters:

diagramFileName - the file name in which the diagram should be saved

objectList - the list of objects to display

Returns:

the file name (= diagramFileName), for compatibility with dumpPng(Object...)

dumpYaml

public java.lang.String dumpYaml(java.lang.String diagramFileName,
                                 java.lang.Object... objectList)

Create yaml description.

Parameters:

diagramFileName - the file name in which the diagram should be saved

objectList - the list of objects to display

Returns:

the file name (= diagramFileName), for compatibility with dumpPng(Object...)