01: /*
02: * ProcessingElement.java
03: *
04: * This work is free software; you can redistribute it and/or modify
05: * it under the terms of the GNU General Public License as published
06: * by the Free Software Foundation; either version 2 of the License,
07: * or (at your option) any later version.
08: *
09: * This work is distributed in the hope that it will be useful, but
10: * WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12: * General Public License for more details.
13: *
14: * You should have received a copy of the GNU General Public License
15: * along with this program; if not, write to the Free Software
16: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
17: * USA
18: *
19: * As a special exception, the copyright holders of this library give
20: * you permission to link this library with independent modules to
21: * produce an executable, regardless of the license terms of these
22: * independent modules, and to copy and distribute the resulting
23: * executable under terms of your choice, provided that you also meet,
24: * for each linked independent module, the terms and conditions of the
25: * license of that module. An independent module is a module which is
26: * not derived from or based on this library. If you modify this
27: * library, you may extend this exception to your version of the
28: * library, but you are not obligated to do so. If you do not wish to
29: * do so, delete this exception statement from your version.
30: *
31: * Copyright (c) 2003 Per Cederberg. All rights reserved.
32: */
33:
34: package net.percederberg.grammatica.ant;
35:
36: import org.apache.tools.ant.BuildException;
37:
38: import net.percederberg.grammatica.Grammar;
39:
40: /**
41: * An grammar processing element. A processing element transforms the
42: * grammar to some other form, normally source code. One or more
43: * processing elements may be present in the Grammatica Ant task.
44: *
45: * @author Per Cederberg, <per at percederberg dot net>
46: * @version 1.4
47: * @since 1.4
48: */
49: public interface ProcessingElement {
50:
51: /**
52: * Validates all attributes in the element.
53: *
54: * @throws BuildException if some attribute was missing or had an
55: * invalid value
56: */
57: void validate() throws BuildException;
58:
59: /**
60: * Proceses the specified grammar.
61: *
62: * @param grammar the grammar to process
63: *
64: * @throws BuildException if the grammar couldn't be processed
65: * correctly
66: */
67: void process(Grammar grammar) throws BuildException;
68: }
|