Package org.tquadrat.foundation.javadoc

Class UmlGraphLinkTaglet

java.lang.Object

org.tquadrat.foundation.javadoc.UmlGraphLinkTaglet

All Implemented Interfaces:

Taglet

@ClassVersion(sourceVersion="$Id: UmlGraphLinkTaglet.java 1013 2022-02-08 21:30:29Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public class UmlGraphLinkTaglet
extends Object
implements Taglet

When this tag is added to the documentation of a class, a UML graph will be created for this class and added to the documentation.

The JavaDoc generation will be serialised on this taglet.

Author:

Thomas Thrien - thomas.thrien@tquadrat.org

Version:

$Id: UmlGraphLinkTaglet.java 1013 2022-02-08 21:30:29Z tquadrat $

Since:

0.1.0

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Taglet

Taglet.Location

Field Summary

Fields

Modifier and Type	Field	Description
private static final Map<Name,UMLTypeElement>	m_ClassRegistry	The registry for the type elements; it is used as a cache for the already processed classes.
private Doclet	m_Doclet	The doclet.
private DocletEnvironment	m_DocletEnvironment	The doclet environment.
private static final Lock	m_Lock	The lock that controls the processing for this taglet.
static final String	TAGLET_NAME	The name of this taglet: "UMLGraph.link".

Constructor Summary

Constructors

Constructor	Description
UmlGraphLinkTaglet()	Creates a new UmlGraphLinkTaglet instance.

Method Summary

Modifier and Type	Method	Description
private static final String	determineImageFileName(TypeElement typeElement)	Determines the image file name based on the name of the given type element.
final Set<Taglet.Location>	getAllowedLocations()
final String	getName()
private final boolean	hasParent(UMLTypeElement typeElement)	Checks whether the given type element has at least one parent. Interfaces that do not extend another interface are parent-less; Object is the only class that does not have a parent class.
final void	init(DocletEnvironment docletEnvironment, Doclet doclet)
private final void	initInheritance(UMLTypeElement typeElement)	Assigns the given type element to its parents. This method modifies the cache for the type elements, therefore it requires the lock.
final boolean	isInlineTag()
private final void	layout(UMLDocument document, UMLTypeElement focusClass, int details)	Do the layout for the graph.
private final Collection<UMLTypeElement>	retrieveParents(UMLTypeElement typeElement)	Retrieves the direct parents for the given type. As this method potentially modifies the cache, it requires the lock.
final String	toString(List<? extends DocTree> tags, Element element)

Methods inherited from class java.lang.Object

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

Methods inherited from interface jdk.javadoc.doclet.Taglet

isBlockTag

Field Details

TAGLET_NAME

public static final String TAGLET_NAME

The name of this taglet: "UMLGraph.link".

See Also:

• Constant Field Values

m_Doclet

private Doclet m_Doclet

The doclet.

m_DocletEnvironment

private DocletEnvironment m_DocletEnvironment

The doclet environment.

m_ClassRegistry

private static final Map<Name,UMLTypeElement> m_ClassRegistry

The registry for the type elements; it is used as a cache for the already processed classes.

m_Lock

private static final Lock m_Lock

The lock that controls the processing for this taglet.

Constructor Details

UmlGraphLinkTaglet

public UmlGraphLinkTaglet()

Creates a new UmlGraphLinkTaglet instance.

Method Details

determineImageFileName

private static final String determineImageFileName(TypeElement typeElement)

Determines the image file name based on the name of the given type element. The returned value is not the fully qualified file name, just the last part of it.

For the class com.bar.MyClass, this method would return the file name doc-files/MyClass.svg.

Parameters:

typeElement - The type element.

Returns:

The name of the image file that belongs to the given type element.

getAllowedLocations

public final Set<Taglet.Location> getAllowedLocations()

Specified by:

getAllowedLocations in interface Taglet

getName

public final String getName()

Specified by:

getName in interface Taglet

hasParent

private final boolean hasParent(UMLTypeElement typeElement)

Checks whether the given type element has at least one parent.

Interfaces that do not extend another interface are parent-less; Object is the only class that does not have a parent class.

Parameters:

typeElement - The type element to examine.

Returns:

true if the element has at least one parent, false otherwise.

init

public final void init(DocletEnvironment docletEnvironment,
 Doclet doclet)

Specified by:

init in interface Taglet

initInheritance

private final void initInheritance(UMLTypeElement typeElement)

Assigns the given type element to its parents.

This method modifies the cache for the type elements, therefore it requires the lock.

Parameters:

typeElement - The type element.

See Also:

• m_ClassRegistry
• m_Lock
• retrieveParents(UMLTypeElement)

isInlineTag

public final boolean isInlineTag()

Specified by:

isInlineTag in interface Taglet

layout

private final void layout(UMLDocument document,
 UMLTypeElement focusClass,
 int details)

Do the layout for the graph.

Parameters:

document - The UML document.

focusClass - The class doc for the focus class.

details - The level of details for the UMLGraph:

• 1: only elements should be shown that are relevant for the API
• 2: all elements should be shown.

retrieveParents

private final Collection<UMLTypeElement> retrieveParents(UMLTypeElement typeElement)

Retrieves the direct parents for the given type.

As this method potentially modifies the cache, it requires the lock.

Parameters:

typeElement - The type element.

Returns:

The direct parents for the given type element.

See Also:

• m_ClassRegistry
• m_Lock

toString

public final String toString(List<? extends DocTree> tags,
 Element element)

Specified by:

toString in interface Taglet