01: /**
02: * Speedo: an implementation of JDO compliant personality on top of JORM generic
03: * I/O sub-system.
04: * Copyright (C) 2001-2004 France Telecom R&D
05: *
06: * This library is free software; you can redistribute it and/or
07: * modify it under the terms of the GNU Lesser General Public
08: * License as published by the Free Software Foundation; either
09: * version 2 of the License, or (at your option) any later version.
10: *
11: * This library is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14: * Lesser General Public License for more details.
15: *
16: * You should have received a copy of the GNU Lesser General Public
17: * License along with this library; if not, write to the Free Software
18: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19: *
20: *
21: *
22: * Contact: speedo@objectweb.org
23: *
24: * Authors: S.Chassande-Barrioz.
25: *
26: */package org.objectweb.speedo.generation.api;
27:
28: import org.objectweb.speedo.api.SpeedoException;
29:
30: /**
31: * Defines a component of the Speedo generator.
32: *
33: * @author S.Chassande-Barrioz
34: */
35: public interface GeneratorComponent {
36:
37: /**
38: * Assignes the parameters holder
39: */
40: void setSpeedoCompilerParameter(SpeedoCompilerParameter scp);
41:
42: /**
43: * Retrieves the parameters holder
44: */
45: SpeedoCompilerParameter getSpeedoCompilerParameter();
46:
47: /**
48: * Initializes the component
49: * @return boolean value indicating if the process method can be called.
50: *
51: * @throws SpeedoException if the component initialization fails
52: */
53: boolean init() throws SpeedoException;
54:
55: /**
56: * Do the job of the component.
57: * @throws SpeedoException if the component initialization fails
58: */
59: void process() throws SpeedoException;
60:
61: /**
62: * @return a short string (less than 30 characters) representing the
63: * title of the component. This string must indicate job of the component.
64: */
65: String getTitle();
66:
67: /**
68: * @return a short string (less than 50 characters) summarizing the job of
69: * component (ex: how many files generated or compiled, ...)
70: */
71: String getSummary();
72:
73: }
|