01: /*
02: * Spoon - http://spoon.gforge.inria.fr/
03: * Copyright (C) 2006 INRIA Futurs <renaud.pawlak@inria.fr>
04: *
05: * This software is governed by the CeCILL-C License under French law and
06: * abiding by the rules of distribution of free software. You can use, modify
07: * and/or redistribute the software under the terms of the CeCILL-C license as
08: * circulated by CEA, CNRS and INRIA at http://www.cecill.info.
09: *
10: * This program is distributed in the hope that it will be useful, but WITHOUT
11: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12: * FITNESS FOR A PARTICULAR PURPOSE. See the CeCILL-C License for more details.
13: *
14: * The fact that you are presently reading this means that you have had
15: * knowledge of the CeCILL-C license and that you accept its terms.
16: */
17:
18: package spoon.processing;
19:
20: import java.io.File;
21: import java.util.List;
22:
23: import spoon.reflect.declaration.CtElement;
24:
25: /**
26: * This interface should be implemented by processing tasks that generate new
27: * files as processing results. This interface is typically implemented by
28: * processors that generate files during processing. For a given processing
29: * environment, the default file generator is set to the default ouput directory
30: * that is retrieved by using
31: * {@link spoon.processing.Environment#getDefaultFileGenerator()}.
32: */
33: public interface FileGenerator<T extends CtElement> extends
34: Processor<T> {
35:
36: /**
37: * Sets the root directory where files should be created.
38: */
39: public void setOutputDirectory(File directory);
40:
41: /**
42: * Gets the root directory where files are created.
43: */
44: public File getOutputDirectory();
45:
46: /**
47: * Gets the created files.
48: */
49: public List<File> getCreatedFiles();
50:
51: }
|