Package nl.talsmasoftware.umldoclet.uml

Class Link

java.lang.Object

nl.talsmasoftware.umldoclet.uml.UMLNode

nl.talsmasoftware.umldoclet.uml.Link

public class Link
extends UMLNode

Class for rendering links in the generated UML

Author:

Sjoerd Talsma

Method Summary

Modifier and Type	Method	Description
static Link	forPackage(Namespace namespace)
static Link	forType(Type type)
static boolean	linkFrom(String basePath)	Sets the base path where relative links should be rendered from.
<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, getConfiguration, getParent, removeChildren, setParent, toString, writeChildrenTo

Methods inherited from class java.lang.Object

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

Method Details

forType

public static Link forType(Type type)

forPackage

public static Link forPackage(Namespace namespace)

linkFrom

public static boolean linkFrom(String basePath)

Sets the base path where relative links should be rendered from.

This setting is configured on a per-thread basis.

Parameters:

basePath - The base path to define relative links from.

Returns:

whether the base path was modified or not

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.