net.sourceforge.plantumldependency.cli.plantumldiagram

Interface WithDescription

All Known Subinterfaces:

PlantUMLClassesDiagram, PlantUMLClassesDiagramAbstractClassElement, PlantUMLClassesDiagramAnnotationElement, PlantUMLClassesDiagramClassElement, PlantUMLClassesDiagramElement, PlantUMLClassesDiagramEnumElement, PlantUMLClassesDiagramExtendRelation, PlantUMLClassesDiagramImplementRelation, PlantUMLClassesDiagramInterfaceElement, PlantUMLClassesDiagramRelation, PlantUMLClassesDiagramUseRelation, PlantUMLDiagram, PlantUMLSpottedCharacter, PlantUMLStereotype

All Known Implementing Classes:

AbstractPlantUMLClassesDiagramElement, AbstractPlantUMLClassesDiagramRelation, PlantUMLClassesDiagramAbstractClassElementImpl, PlantUMLClassesDiagramAnnotationElementImpl, PlantUMLClassesDiagramClassElementImpl, PlantUMLClassesDiagramEnumElementImpl, PlantUMLClassesDiagramExtendRelationImpl, PlantUMLClassesDiagramImpl, PlantUMLClassesDiagramImplementRelationImpl, PlantUMLClassesDiagramInterfaceElementImpl, PlantUMLClassesDiagramUseRelationImpl, PlantUMLSpottedCharacterImpl, PlantUMLStereotypeImpl

public interface WithDescription

The interface which marks an object as serializable into a plantUML text description.

Since:

1.1.1

Version:

1.3.0

Author:

Benjamin Croizet (

Method Summary

Methods

Modifier and Type	Method and Description
String	getPlantUMLTextDescription() Returns the String representing the object as a plantUML text.

Method Detail

getPlantUMLTextDescription

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.

Returns:

the String representing the object as a plantUML text description.

Since:

1.1.1