net.kemitix.dependency.digraph.maven.plugin

Class AbstractDotFileFormat

java.lang.Object

net.kemitix.dependency.digraph.maven.plugin.AbstractDotFileFormat

All Implemented Interfaces:

DotFileFormat

@Immutable
public abstract class AbstractDotFileFormat
extends Object
implements DotFileFormat

Abstract base for DotFileFormat implementations.

Author:

Paul Campbell (pcampbell@kemitix.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLOSE_BRACE
static String	DOUBLE_QUOTE

Constructor Summary

Constructors

Constructor and Description
AbstractDotFileFormat(net.kemitix.node.Node<PackageData> base, net.kemitix.dependency.digraph.maven.plugin.NodePathGenerator nodePathGenerator) Constructor.

Method Summary

Modifier and Type	Method and Description
String	render(Digraph digraph) Render the digraph element as a string.
String	render(NodeProperties nodeProperties) Render the node properties as a string.
String	render(PropertyElement propertyElement) Render the property element as a string.
String	renderReport() Generates the report.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.kemitix.dependency.digraph.maven.plugin.DotFileFormat

render, render, render

Field Detail

CLOSE_BRACE

public static final String CLOSE_BRACE

See Also:

Constant Field Values

DOUBLE_QUOTE

public static final String DOUBLE_QUOTE

See Also:

Constant Field Values

Constructor Detail

AbstractDotFileFormat

public AbstractDotFileFormat(net.kemitix.node.Node<PackageData> base,
                             net.kemitix.dependency.digraph.maven.plugin.NodePathGenerator nodePathGenerator)

Constructor.

Parameters:

base - The root node

nodePathGenerator - The Node Path Generator

Method Detail

renderReport

public final String renderReport()

Description copied from interface: DotFileFormat

Generates the report.

Specified by:

renderReport in interface DotFileFormat

Returns:

the formatted report

render

public final String render(Digraph digraph)

Description copied from interface: DotFileFormat

Render the digraph element as a string.

Specified by:

render in interface DotFileFormat

Parameters:

digraph - the digraph to render

Returns:

the rendered digraph

render

public final String render(NodeProperties nodeProperties)

Description copied from interface: DotFileFormat

Render the node properties as a string.

Specified by:

render in interface DotFileFormat

Parameters:

nodeProperties - the node properties to render

Returns:

the rendered node properties

render

public final String render(PropertyElement propertyElement)

Description copied from interface: DotFileFormat

Render the property element as a string.

Specified by:

render in interface DotFileFormat

Parameters:

propertyElement - the property element to render

Returns:

the rendered property element