1 /*
2 WithDescription.java
3 Creation date : 10/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;
26
27 /**
28 * The interface which marks an object as serializable into a plantUML text description.
29 *
30 * @author Benjamin Croizet (<a href="mailto:graffity2199@yahoo.fr>graffity2199@yahoo.fr</a>)
31 * @since 1.1.1
32 * @version 1.3.0
33 */
34 public interface WithDescription {
35
36 /**
37 * Returns the {@link String} representing the object as a plantUML text. Following the object,
38 * it is usually a text corresponding to one of the plantUML diagram.
39 *
40 * @return the {@link String} representing the object as a plantUML text description.
41 * @since 1.1.1
42 */
43 String getPlantUMLTextDescription();
44 }