KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > beehive > controls > runtime > generator > Generator


1 package org.apache.beehive.controls.runtime.generator;
2 /*
3  * Copyright 2004 The Apache Software Foundation.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  * $Header:$
18  */

19
20 import java.io.IOException JavaDoc;
21 import java.util.HashMap JavaDoc;
22 import java.util.List JavaDoc;
23
24 import com.sun.mirror.apt.Filer;
25
26 /**
27  * The Generator interface will be implemented by APT data types that result in the generation
28  * of new source or text artifacts.
29  * for template usage on class-type objects
30  * <p>
31  * This is done with an abstract class (instead of an interface) so derived abstract classes
32  * can be subclassed from it w/out requiring all of the methods to be declared there.
33  */

34 public interface Generator
35 {
36     /**
37      * Returns the list of fully qualified class names for types that are derived
38      * from this Generator
39      */

40     public String JavaDoc [] getGeneratedTypes();
41     
42     /**
43      * Returns the list of generated files derived from this Generator during the
44      * check phase of annotation processing.
45      */

46     public List JavaDoc<GeneratorOutput> getCheckOutput(Filer filer) throws IOException JavaDoc;
47
48     /**
49      * Returns the list of generated files derived from this Generator during the
50      * generate phase of annotation processing.
51      */

52     public List JavaDoc<GeneratorOutput> getGenerateOutput(Filer filer) throws IOException JavaDoc;
53 }
54
Popular Tags