net.sourceforge.plantumldependency.cli.plantumldiagram.classes.element

Class AbstractPlantUMLClassesDiagramElement

java.lang.Object

net.sourceforge.plantumldependency.cli.plantumldiagram.classes.element.AbstractPlantUMLClassesDiagramElement

All Implemented Interfaces:

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

Direct Known Subclasses:

PlantUMLClassesDiagramAnnotationElementImpl, PlantUMLClassesDiagramClassElementImpl, PlantUMLClassesDiagramEnumElementImpl, PlantUMLClassesDiagramInterfaceElementImpl

public abstract class AbstractPlantUMLClassesDiagramElement
extends Object
implements PlantUMLClassesDiagramElement

The abstract implementation of the PlantUMLClassesDiagramElement interface.

Since:

1.1.1

Version:

1.3.0

Author:

Benjamin Croizet (See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPlantUMLClassesDiagramElement(String fullName, PlantUMLClassesDiagramElementTag tag) Full constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(PlantUMLClassesDiagramElement o)
PlantUMLClassesDiagramElement	deepClone()
boolean	equals(Object obj)
protected abstract String	getAdditionalPlantUMLTextDescription() Gets an additional plantUML description, which may be necessary for some element.
PlantUMLClassesDiagramElementTag	getElementTag() Gets the element tag, which represents the element string used in the plantUML classes diagram language.
String	getName() Gets the full element name, i.e. the package name and the element name.
String	getPlantUMLTextDescription() Returns the String representing the object as a plantUML text.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPlantUMLClassesDiagramElement

protected AbstractPlantUMLClassesDiagramElement(String fullName,
                                     PlantUMLClassesDiagramElementTag tag)

Full constructor.

Parameters:

fullName - the element full name, mustn't be null.

tag - plantUML element tag available in the plantUML classes diagram language, mustn't be null.

Since:

1.1.1

Method Detail

compareTo

public int compareTo(PlantUMLClassesDiagramElement o)

Specified by:

compareTo in interface Comparable<PlantUMLClassesDiagramElement>

Since:

1.1.1

deepClone

public PlantUMLClassesDiagramElement deepClone()

Specified by:

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

Since:

1.1.1

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Since:

1.1.1

getAdditionalPlantUMLTextDescription

protected abstract String getAdditionalPlantUMLTextDescription()

Gets an additional plantUML description, which may be necessary for some element.

Returns:

an additional plantUML description.

Since:

1.1.1

getElementTag

public PlantUMLClassesDiagramElementTag getElementTag()

Gets the element tag, which represents the element string used in the plantUML classes diagram language.

Specified by:

getElementTag in interface PlantUMLClassesDiagramElement

Returns:

the element tag, as a PlantUMLClassesDiagramElementTag instance.

Since:

1.1.1

getName

public String getName()

Gets the full element name, i.e. the package name and the element name. For instance, it can be "java.lang.String".

Specified by:

getName in interface PlantUMLClassesDiagramElement

Returns:

the full element name.

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

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