1 package net.sourceforge.jenesis4java;
2
3 /*
4 * #%L
5 * Jenesis 4 Java Code Generator
6 * %%
7 * Copyright (C) 2000 - 2015 jenesis4java
8 * %%
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation, either version 3 of the
12 * License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Lesser Public License for more details.
18 *
19 * You should have received a copy of the GNU General Lesser Public
20 * License along with this program. If not, see
21 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
22 * #L%
23 */
24
25 /**
26 * Copyright (C) 2008, 2010 Richard van Nieuwenhoven - ritchie [at] gmx [dot] at
27 * Copyright (C) 2000, 2001 Paul Cody Johnston - pcj@inxar.org <br>
28 * This file is part of Jenesis4java. Jenesis4java is free software: you can
29 * redistribute it and/or modify it under the terms of the GNU Lesser General
30 * Public License as published by the Free Software Foundation, either version 3
31 * of the License, or (at your option) any later version.<br>
32 * Jenesis4java is distributed in the hope that it will be useful, but WITHOUT
33 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
34 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
35 * details.<br>
36 * You should have received a copy of the GNU Lesser General Public License
37 * along with Jenesis4java. If not, see <http://www.gnu.org/licenses/>.
38 */
39 /**
40 * The {@code Statement} superinterface. All statements can be optionally
41 * labeled.
42 */
43 public interface Statement extends Codeable {
44
45 /**
46 * Comments the statement.
47 */
48 Comment comment(String text);
49
50 /**
51 * Gets the label for the statement.
52 */
53 String getLabel();
54
55 /**
56 * Returns {@code true} if the {@code Statement} is a statement that
57 * completes abruptly (as defined in The Java language specification, 2nd
58 * Edition,Chapter 14.1 - see <a href=
59 * "http://java.sun.com/docs/books/jls/second_edition/html/statements.doc.html#5894"
60 * >Normal and Abrupt Completion of Statements</a>).
61 *
62 * @return {@code true} if the {@code Statement} is a statement that
63 * completes abruptly
64 */
65 boolean isAbruptCompletionStatement();
66
67 /**
68 * Sets the label for the statement.
69 */
70 Statement setLabel(String label);
71 }