Package nl.talsmasoftware.umldoclet.uml

Class Diagram

java.lang.Object

nl.talsmasoftware.umldoclet.uml.UMLNode

nl.talsmasoftware.umldoclet.uml.Diagram

Direct Known Subclasses:

ClassDiagram, DependencyDiagram, PackageDiagram

public abstract class Diagram
extends UMLNode

Abstract UML Diagram class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Diagram(Configuration config)

Method Summary

Modifier and Type	Method	Description
Configuration	getConfiguration()
protected abstract File	getPlantUmlFile()	Determine the physical file location for the plantuml output.
void	render()
String	toString()	Renders the entire content of this renderer and returns it as a String value.
protected <IPW extends IndentingPrintWriter> IPW	writeCustomDirectives(List<String> customDirectives, IPW output)
<IPW extends IndentingPrintWriter> IPW	writeTo(IPW output)	Renders this object to the given indenting output.

Methods inherited from class nl.talsmasoftware.umldoclet.uml.UMLNode

addChild, findParent, getChildren, getChildren, getParent, removeChildren, setParent, writeChildrenTo

Methods inherited from class java.lang.Object

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

Constructor Details

Diagram

protected Diagram(Configuration config)

Method Details

writeTo

public <IPW extends IndentingPrintWriter> IPW writeTo(IPW output)

Description copied from class: UMLNode

Renders this object to the given indenting output.

Specified by:

writeTo in class UMLNode

Type Parameters:

IPW - The subclass of indenting print writer being written to.

Parameters:

output - The output to render this object to.

Returns:

A reference to the output for method chaining purposes.

writeCustomDirectives

protected <IPW extends IndentingPrintWriter> IPW writeCustomDirectives(List<String> customDirectives,
 IPW output)

getConfiguration

public Configuration getConfiguration()

Overrides:

getConfiguration in class UMLNode

getPlantUmlFile

protected abstract File getPlantUmlFile()

Determine the physical file location for the plantuml output.

This will even be called if -createPumlFiles is not enabled, to determine the diagram base file.

Returns:

The physical file for the plantuml output.

render

public void render()

toString

public String toString()

Description copied from class: UMLNode

Renders the entire content of this renderer and returns it as a String value.

Overrides:

toString in class UMLNode

Returns:

The rendered content of this renderer.