net.sourceforge.plantumldependency.cli.plantumldiagram.classes.relation

Class AbstractPlantUMLClassesDiagramRelation

java.lang.Object

net.sourceforge.plantumldependency.cli.plantumldiagram.classes.relation.AbstractPlantUMLClassesDiagramRelation

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PlantUMLClassesDiagramRelation>, PlantUMLClassesDiagramRelation, WithDescription, net.sourceforge.plantumldependency.common.clone.DeepCloneable<PlantUMLClassesDiagramRelation>

Direct Known Subclasses:

PlantUMLClassesDiagramExtendRelationImpl, PlantUMLClassesDiagramImplementRelationImpl, PlantUMLClassesDiagramUseRelationImpl

public abstract class AbstractPlantUMLClassesDiagramRelation
extends Object
implements PlantUMLClassesDiagramRelation

The abstract implementation of the PlantUMLClassesDiagramRelation interface.

Since:

1.1.1

Version:

1.3.0

Author:

Benjamin Croizet (See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPlantUMLClassesDiagramRelation(PlantUMLClassesDiagramElement firstElt, PlantUMLClassesDiagramElement secondElt, PlantUMLClassesDiagramRelationType relationType) Full constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(PlantUMLClassesDiagramRelation o)
PlantUMLClassesDiagramRelation	deepClone()
boolean	equals(Object obj)
PlantUMLClassesDiagramElement	getFirstElement() Gets the first element of the relation.
String	getPlantUMLTextDescription() Returns the String representing the object as a plantUML text.
PlantUMLClassesDiagramElement	getSecondElement() Gets the second element of the relation.
PlantUMLClassesDiagramRelationType	getType() Gets the relation type used in the plantUML language.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractPlantUMLClassesDiagramRelation

protected AbstractPlantUMLClassesDiagramRelation(PlantUMLClassesDiagramElement firstElt,
                                      PlantUMLClassesDiagramElement secondElt,
                                      PlantUMLClassesDiagramRelationType relationType)

Full constructor.

Parameters:

firstElt - The first element of the relation, mustn't be null nor empty.

secondElt - The second element of the relation, mustn't be null nor empty.

relationType - The relation type used in the plantUML language, mustn't be null.

Since:

1.1.1

Method Detail

compareTo

public int compareTo(PlantUMLClassesDiagramRelation o)

Specified by:

compareTo in interface Comparable<PlantUMLClassesDiagramRelation>

Since:

1.1.1

deepClone

public PlantUMLClassesDiagramRelation deepClone()

Specified by:

deepClone in interface net.sourceforge.plantumldependency.common.clone.DeepCloneable<PlantUMLClassesDiagramRelation>

Since:

1.1.1

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Since:

1.1.1

getFirstElement

public PlantUMLClassesDiagramElement getFirstElement()

Gets the first element of the relation.

Specified by:

getFirstElement in interface PlantUMLClassesDiagramRelation

Returns:

the first element of the relation.

Since:

1.1.1

getPlantUMLTextDescription

public String getPlantUMLTextDescription()

Returns the String representing the object as a plantUML text. Following the object, it is usually a text corresponding to one of the plantUML diagram.

Specified by:

getPlantUMLTextDescription in interface WithDescription

Returns:

the String representing the object as a plantUML text description.

Since:

1.1.1

getSecondElement

public PlantUMLClassesDiagramElement getSecondElement()

Gets the second element of the relation.

Specified by:

getSecondElement in interface PlantUMLClassesDiagramRelation

Returns:

the second element of the relation.

Since:

1.1.1

getType

public PlantUMLClassesDiagramRelationType getType()

Gets the relation type used in the plantUML language.

Specified by:

getType in interface PlantUMLClassesDiagramRelation

Returns:

the relation type used in the plantUML language.

Since:

1.1.1

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Since:

1.1.1

toString

public String toString()

Overrides:

toString in class Object

Since:

1.1.1