KickJava   Java API By Example, From Geeks To Geeks.

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


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 GenClass abstract class defines a base set of methods that are generally available
28  * for template usage on class-type objects
29  * <p>
30  * This is done with an abstract class (instead of an interface) so derived abstract classes
31  * can be subclassed from it w/out requiring all of the methods to be declared there.
32  */
33 abstract public class GenClass
34 {
35     /**
36      * Returns the fully qualified classname associated with the GenClass
37      */
38     abstract public String JavaDoc getClassName();
39
40     /**
41      * Returns the base package name associated with the GenClass
42      */
43     abstract public String JavaDoc getPackage();
44
45     /**
46      * Returns the unqualified class name associated with the GenClass
47      */
48     abstract public String JavaDoc getShortName();
49
50     /**
51      * Returns the super class for this class
52      */
53     abstract public GenClass getSuperClass();
54
55     /**
56      * Returns true if the GenClass extends another class
57      */
58     public boolean hasSuperClass()
59     {
60         return getSuperClass() != null;
61     }
62
63     /**
64      * Returns the list of fully qualified class names for types that are derived
65      * from this GenClass
66      */
67     public String JavaDoc [] getGeneratedTypes()
68     {
69         return null;
70     }
71     
72     /**
73      * Returns the list of generated files derived from this GenClass during the
74      * check phase of annotation processing.
75      */
76     public List JavaDoc<GeneratorOutput> getCheckOutput(Filer filer) throws IOException JavaDoc
77     {
78         return null;
79     }
80
81     /**
82      * Returns the list of generated files derived from this GenClass during the
83      * generate phase of annotation processing.
84      */
85     public List JavaDoc<GeneratorOutput> getGenerateOutput(Filer filer) throws IOException JavaDoc
86     {
87         return null;
88     }
89 }
90
Popular Tags