1 /*
2 PlantUMLClassesDiagramElement.java
3 Creation date : 6/12/2011
4 Copyright © Benjamin Croizet (graffity2199@yahoo.fr)
5
6 This program is free software; you can redistribute it and/or
7 modify it under the terms of the GNU General Public License
8 or GNU Lesser General Public License as published by the
9 Free Software Foundation; either version 3 of the License,
10 or (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received copies of the GNU General Public License
18 and GNU Lesser General Public License along with this program;
19 if not, write to the Free Software Foundation, Inc.,
20 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 http://www.fsf.org/licensing/licenses/gpl.html
22 http://www.gnu.org/licenses/lgpl.html
23 */
24
25 package net.sourceforge.plantumldependency.cli.plantumldiagram.classes.element;
26
27 import java.io.Serializable;
28
29 import net.sourceforge.plantumldependency.cli.plantumldiagram.WithDescription;
30 import net.sourceforge.plantumldependency.cli.plantumldiagram.classes.element.tag.PlantUMLClassesDiagramElementTag;
31 import net.sourceforge.plantumldependency.common.clone.DeepCloneable;
32
33 /**
34 * The mother interface of all plantUML classes diagram elements. The classic elements are usually
35 * "class", "interface", "enum" and "abstract class".
36 *
37 * @author Benjamin Croizet (<a href="mailto:graffity2199@yahoo.fr>graffity2199@yahoo.fr</a>)
38 * @since 1.1.1
39 * @version 1.3.0
40 */
41 public interface PlantUMLClassesDiagramElement extends WithDescription,
42 DeepCloneable < PlantUMLClassesDiagramElement >, Serializable, Comparable < PlantUMLClassesDiagramElement > {
43
44 /**
45 * Gets the element tag, which represents the element string used in the plantUML classes
46 * diagram language.
47 *
48 * @return the element tag, as a {@link PlantUMLClassesDiagramElementTag} instance.
49 * @since 1.1.1
50 */
51 PlantUMLClassesDiagramElementTag getElementTag();
52
53 /**
54 * Gets the full element name, i.e. the package name and the element name. For instance, it can
55 * be "java.lang.String".
56 *
57 * @return the full element name.
58 * @since 1.1.1
59 */
60 String getName();
61 }