org.apache.beehive.controls.runtime.generator.GenClass Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* $Header:$
*/
package org.apache.beehive.controls.runtime.generator;
import java.io.IOException;
import java.util.List;
import com.sun.mirror.apt.Filer;
/**
* The GenClass abstract class defines a base set of methods that are generally available
* for template usage on class-type objects
*
* This is done with an abstract class (instead of an interface) so derived abstract classes
* can be subclassed from it w/out requiring all of the methods to be declared there.
*/
abstract public class GenClass
{
/**
* Returns the fully qualified classname associated with the GenClass
*/
abstract public String getClassName();
/**
* Returns the base package name associated with the GenClass
*/
abstract public String getPackage();
/**
* Returns the unqualified class name associated with the GenClass
*/
abstract public String getShortName();
/**
* Returns the super class for this class
*/
abstract public GenClass getSuperClass();
/**
* Returns true if the GenClass extends another class
*/
public boolean hasSuperClass()
{
return getSuperClass() != null;
}
/**
* Returns the list of fully qualified class names for types that are derived
* from this GenClass
*/
public String [] getGeneratedTypes()
{
return null;
}
/**
* Returns the list of generated files derived from this GenClass during the
* check phase of annotation processing.
*/
public List getCheckOutput(Filer filer) throws IOException
{
return null;
}
/**
* Returns the list of generated files derived from this GenClass during the
* generate phase of annotation processing.
*/
public List getGenerateOutput(Filer filer) throws IOException
{
return null;
}
}