Package ch.ifocusit.plantuml

Class PlantUmlBuilder

java.lang.Object

ch.ifocusit.plantuml.PlantUmlBuilder

public class PlantUmlBuilder
extends Object

Plantuml diagram helper for java classes.

Author:

Julien Boz

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BRACE_CLOSE
static final String	BRACE_OPEN
static final String	BRACKET_CLOSE
static final String	BRACKET_OPEN
static final String	COMMA
static final String	HASHTAG
static final String	NEWLINE
static final String	PACKAGE_TMPL
static final String	QUOTE
static final String	SEMICOLON
static final String	STEREOTYPE_CLOSE
static final String	STEREOTYPE_OPEN
static final String	TAB

Constructor Summary

Constructors

Constructor	Description
PlantUmlBuilder()

Method Summary

Modifier and Type	Method	Description
PlantUmlBuilder	addAssociation(Association association)
PlantUmlBuilder	addAssociation(String aName, String bName)
PlantUmlBuilder	addAssociation(String aName, String bName, Association.AssociationType type)
PlantUmlBuilder	addAssociation(String aName, String bName, Association.AssociationType type, String label)
PlantUmlBuilder	addAssociation(String aName, String bName, Association.AssociationType type, String label, Cardinality aCardinality, Cardinality bCardinality)
PlantUmlBuilder	addAssociation(String aName, String bName, String label)
PlantUmlBuilder	addPackage(Package aPackage, Clazz... classes)
PlantUmlBuilder	addType(Clazz clazz)
PlantUmlBuilder	append(String value)
PlantUmlBuilder	appendFooter(String footer)
PlantUmlBuilder	appendHeader(String header)
PlantUmlBuilder	appendTitle(String title)
String	build()
PlantUmlBuilder	end(String... options)
PlantUmlBuilder	start(String... options)

Methods inherited from class java.lang.Object

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

Field Details

SEMICOLON

public static final String SEMICOLON

See Also:

• Constant Field Values

COMMA

public static final String COMMA

See Also:

• Constant Field Values

BRACE_OPEN

public static final String BRACE_OPEN

See Also:

• Constant Field Values

BRACE_CLOSE

public static final String BRACE_CLOSE

See Also:

• Constant Field Values

STEREOTYPE_OPEN

public static final String STEREOTYPE_OPEN

See Also:

• Constant Field Values

STEREOTYPE_CLOSE

public static final String STEREOTYPE_CLOSE

See Also:

• Constant Field Values

TAB

public static final String TAB

See Also:

• Constant Field Values

NEWLINE

public static final String NEWLINE

QUOTE

public static final String QUOTE

See Also:

• Constant Field Values

HASHTAG

public static final String HASHTAG

See Also:

• Constant Field Values

PACKAGE_TMPL

public static final String PACKAGE_TMPL

See Also:

• Constant Field Values

BRACKET_OPEN

public static final String BRACKET_OPEN

See Also:

• Constant Field Values

BRACKET_CLOSE

public static final String BRACKET_CLOSE

See Also:

• Constant Field Values

Constructor Details

PlantUmlBuilder

public PlantUmlBuilder()

Method Details

build

public String build()

append

public PlantUmlBuilder append(String value)

start

public PlantUmlBuilder start(String... options)

end

public PlantUmlBuilder end(String... options)

appendTitle

public PlantUmlBuilder appendTitle(String title)

appendHeader

public PlantUmlBuilder appendHeader(String header)

appendFooter

public PlantUmlBuilder appendFooter(String footer)

addPackage

public PlantUmlBuilder addPackage(Package aPackage,
 Clazz... classes)

addType

public PlantUmlBuilder addType(Clazz clazz)

addAssociation

public PlantUmlBuilder addAssociation(String aName,
 String bName)

addAssociation

public PlantUmlBuilder addAssociation(String aName,
 String bName,
 Association.AssociationType type)

addAssociation

public PlantUmlBuilder addAssociation(String aName,
 String bName,
 String label)

addAssociation

public PlantUmlBuilder addAssociation(String aName,
 String bName,
 Association.AssociationType type,
 String label)

addAssociation

public PlantUmlBuilder addAssociation(Association association)

addAssociation

public PlantUmlBuilder addAssociation(String aName,
 String bName,
 Association.AssociationType type,
 String label,
 Cardinality aCardinality,
 Cardinality bCardinality)