1 /*
2 PlantUMLClassesDiagramRelation.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.relation;
26
27 import java.io.Serializable;
28
29 import net.sourceforge.plantumldependency.cli.plantumldiagram.WithDescription;
30 import net.sourceforge.plantumldependency.cli.plantumldiagram.classes.element.PlantUMLClassesDiagramElement;
31 import net.sourceforge.plantumldependency.common.clone.DeepCloneable;
32
33 /**
34 * The mother interface of all plantUML classes diagram relations. The classic relations used are
35 * usually "implements", "extends" and "uses".<br>
36 * A relation contains two element and the relation should always be read as follows :<br>
37 * "First Element -> Second Element"
38 *
39 * @author Benjamin Croizet (<a href="mailto:graffity2199@yahoo.fr>graffity2199@yahoo.fr</a>)
40 * @since 1.1.1
41 * @version 1.3.0
42 */
43 public interface PlantUMLClassesDiagramRelation extends WithDescription,
44 DeepCloneable < PlantUMLClassesDiagramRelation >, Serializable, Comparable < PlantUMLClassesDiagramRelation > {
45
46 /**
47 * Gets the first element of the relation.
48 *
49 * @return the first element of the relation.
50 * @since 1.1.1
51 */
52 PlantUMLClassesDiagramElement getFirstElement();
53
54 /**
55 * Gets the second element of the relation.
56 *
57 * @return the second element of the relation.
58 * @since 1.1.1
59 */
60 PlantUMLClassesDiagramElement getSecondElement();
61
62 /**
63 * Gets the relation type used in the plantUML language.
64 *
65 * @return the relation type used in the plantUML language.
66 * @since 1.1.1
67 */
68 PlantUMLClassesDiagramRelationType getType();
69 }