de.elnarion.util.plantuml.generator.classdiagram

Class UMLRelationship

java.lang.Object

de.elnarion.util.plantuml.generator.classdiagram.UMLRelationship

All Implemented Interfaces:

PlantUMLDiagramElement

public class UMLRelationship
extends Object
implements PlantUMLDiagramElement

The Class UMLRelationship encapsulates all information needed for creating a diagram text for a uml relationship object..

Constructor Summary

Constructors

Constructor and Description
UMLRelationship(String paramFromMultiplicity, String paramToMultiplicity, String paramName, String paramFromName, String paramToName, RelationshipType paramRelationshipType) Instantiates a new UML relationship.

Method Summary

Modifier and Type	Method and Description
String	getDiagramText() Gets the diagram text.
String	getFromMultiplicity() Gets the from multiplicity.
String	getFromName() Gets the from name.
String	getName() Gets the name.
RelationshipType	getRelationshiptype() Gets the relationshiptype.
String	getToMultiplicity() Gets the to multiplicity.
String	getToName() Gets the to name.

Methods inherited from class java.lang.Object

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

Constructor Detail

UMLRelationship

public UMLRelationship(String paramFromMultiplicity,
                       String paramToMultiplicity,
                       String paramName,
                       String paramFromName,
                       String paramToName,
                       RelationshipType paramRelationshipType)

Instantiates a new UML relationship.

Parameters:

paramFromMultiplicity - - String - the from multiplicity of this association as String

paramToMultiplicity - - String - the to multiplicity of this association as String

paramName - - String - the name of this relationship (normally the field name in the referencing class object)

paramFromName - - String - the class name where this relationship starts (from)

paramToName - - String - the class name where this relationship ends (to)

paramRelationshipType - - RelationshipType - the type of this relationship

Method Detail

getFromMultiplicity

public String getFromMultiplicity()

Gets the from multiplicity.

Returns:

String - the from multiplicity

getToMultiplicity

public String getToMultiplicity()

Gets the to multiplicity.

Returns:

String - the to multiplicity

getName

public String getName()

Gets the name.

Returns:

String - the name

getFromName

public String getFromName()

Gets the from name.

Returns:

String - the from name

getToName

public String getToName()

Gets the to name.

Returns:

String - the to name

getRelationshiptype

public RelationshipType getRelationshiptype()

Gets the relationshiptype.

Returns:

RelationshipType - the relationshiptype

getDiagramText

public String getDiagramText()

Description copied from interface: PlantUMLDiagramElement

Gets the diagram text.

Specified by:

getDiagramText in interface PlantUMLDiagramElement

Returns:

String - the diagram text