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 * {@code Codeable} is a core interface which nearly all other interfaces
41 * extend. Objects that implement this interface are expected to know how to
42 * render themselves as source code to a {@code CodeWriter}. Any
43 * {@code Codeable} is be commentable as well.
44 */
45 public interface Codeable {
46
47 /**
48 * @return this casted to the parameter class.
49 */
50 <T> T cast(Class<T> clazz);
51
52 /**
53 * Gets the comment for this {@code Codeable} object.
54 */
55 Comment getComment();
56
57 boolean isBlockWithAbruptCompletion();
58
59 /**
60 * Sets the comment to the given type and text.
61 */
62 Codeable setComment(int type, String text);
63
64 /**
65 * Renders the codeable object to the given writer and returns it.
66 */
67 CodeWriter toCode(CodeWriter out);
68
69 /**
70 * walk through the code tree and allow every element to be exchanged.
71 */
72 void visit(ReplacingVisitor visitor);
73
74 /**
75 * Returns the virtual machine to which this {@code Codeable} object
76 * belongs.
77 */
78 VirtualMachine vm();
79
80 Codeable applyStyle(Style style);
81
82 boolean isActive(Style style);
83 }