Package nl.talsmasoftware.umldoclet.uml

Class DependencyDiagram

java.lang.Object

nl.talsmasoftware.umldoclet.uml.UMLNode

nl.talsmasoftware.umldoclet.uml.Diagram

nl.talsmasoftware.umldoclet.uml.DependencyDiagram

public class DependencyDiagram
extends Diagram

UML diagram representing the dependencies between the documented Java packages.

Constructor Summary

Constructors

Constructor	Description
DependencyDiagram(Configuration config, String moduleName, String pumlFileName)

Method Summary

Modifier and Type	Method	Description
void	addPackageDependency(String fromPackage, String toPackage)
List<UMLNode>	getChildren()
protected File	getPlantUmlFile()	Determine the physical file location for the plantuml output.
protected IndentingPrintWriter	writeChildrenTo(IndentingPrintWriter output)	Helper method to write all children to the specified output.
protected <IPW extends IndentingPrintWriter> IPW	writeCustomDirectives(List<String> customDirectives, IPW output)

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

getConfiguration, render, toString, writeTo

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

addChild, findParent, getChildren, getParent, removeChildren, setParent

Methods inherited from class java.lang.Object

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

Constructor Details

DependencyDiagram

public DependencyDiagram(Configuration config,
 String moduleName,
 String pumlFileName)

Method Details

getChildren

public List<UMLNode> getChildren()

Overrides:

getChildren in class UMLNode

addPackageDependency

public void addPackageDependency(String fromPackage,
 String toPackage)

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.getDiagramBaseFile().

Specified by:

getPlantUmlFile in class Diagram

Returns:

The physical file for the plantuml output.

writeCustomDirectives

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

Overrides:

writeCustomDirectives in class Diagram

writeChildrenTo

protected IndentingPrintWriter writeChildrenTo(IndentingPrintWriter output)

Description copied from class: UMLNode

Helper method to write all children to the specified output.

Overrides:

writeChildrenTo in class UMLNode

Parameters:

output - The output to write the children to.

Returns:

A reference to the output for method chaining purposes.