net.sourceforge.plantumldependency.cli.plantumldiagram.classes

Interface PlantUMLClassesDiagram

All Superinterfaces:

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

All Known Implementing Classes:

PlantUMLClassesDiagramImpl

public interface PlantUMLClassesDiagram
extends PlantUMLDiagram

The interface which represents a plantUML classes diagram. A plantUML classes diagram is mainly defined by two things : the elements and their relations to each other.
For instance, this class may be an object oriented description of the following plantUML text :
@startuml
Class01 "1" *-- "many" Class02 : contains
Class03 o-- Class04 : agregation
Class05 --> "1" Class06
@enduml

Since:

1.1.1

Version:

1.3.0

Author:

Benjamin Croizet (See Also:

PlantUML classes diagram page

Method Summary

Methods

Modifier and Type	Method and Description
Set<PlantUMLClassesDiagramElement>	getPlantUMLClassesDiagramElements() Gets all elements contained in the plantUML classes diagram.
Set<PlantUMLClassesDiagramRelation>	getPlantUMLClassesDiagramRelations() Gets all relations contained in the plantUML classes diagram.

Methods inherited from interface net.sourceforge.plantumldependency.cli.plantumldiagram.WithDescription

getPlantUMLTextDescription

Methods inherited from interface net.sourceforge.plantumldependency.common.clone.DeepCloneable

deepClone

Method Detail

getPlantUMLClassesDiagramElements

Set<PlantUMLClassesDiagramElement> getPlantUMLClassesDiagramElements()

Gets all elements contained in the plantUML classes diagram.

Returns:

the Set of all PlantUMLClassesDiagramElement contained in the plantUML classes diagram.

Since:

1.1.1

getPlantUMLClassesDiagramRelations

Set<PlantUMLClassesDiagramRelation> getPlantUMLClassesDiagramRelations()

Gets all relations contained in the plantUML classes diagram.

Returns:

the Set of all PlantUMLClassesDiagramRelation contained in the plantUML classes diagram.

Since:

1.1.1