Package nl.talsmasoftware.umldoclet.uml

Class ClassDiagram

java.lang.Object

nl.talsmasoftware.umldoclet.uml.UMLNode

nl.talsmasoftware.umldoclet.uml.Diagram

nl.talsmasoftware.umldoclet.uml.ClassDiagram

public class ClassDiagram
extends Diagram

UML diagram for a single class.

Constructor Summary

Constructors

Constructor	Description
ClassDiagram(Configuration config, Type type)

Method Summary

Modifier and Type	Method	Description
void	addChild(UMLNode child)
protected File	getPlantUmlFile()	Determine the physical file location for the plantuml output.
Type	getType()
protected <IPW extends IndentingPrintWriter> IPW	writeChildrenTo(IPW output)	Helper method to write all children to the specified output.

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

getConfiguration, render, toString, writeCustomDirectives, writeTo

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

findParent, getChildren, getChildren, getParent, removeChildren, setParent

Methods inherited from class java.lang.Object

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

Constructor Details

ClassDiagram

public ClassDiagram(Configuration config,
 Type type)

Method Details

getType

public Type getType()

addChild

public void addChild(UMLNode child)

Overrides:

addChild in class UMLNode

writeChildrenTo

protected <IPW extends IndentingPrintWriter> IPW writeChildrenTo(IPW output)

Description copied from class: UMLNode

Helper method to write all children to the specified output.

Overrides:

writeChildrenTo in class UMLNode

Type Parameters:

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

Parameters:

output - The output to write the children to.

Returns:

A reference to the output for method chaining purposes.

getPlantUmlFile

protected File getPlantUmlFile()

Description copied from class: Diagram

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.

Specified by:

getPlantUmlFile in class Diagram

Returns:

The physical file for the plantuml output.