org.bridje.ioc

Class ClassListPropertyFile

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.bridje.ioc.ClassListPropertyFile

All Implemented Interfaces:

Processor

Direct Known Subclasses:

ComponentProcessor

public abstract class ClassListPropertyFile
extends AbstractProcessor

Base class for the annotations processors that handle components declaration files.

Field Summary

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
ClassListPropertyFile()

Method Summary

Modifier and Type	Method and Description
protected void	appendProperty(String key, String value) This method appends key=value to the output file.
abstract String	getFileName() Gets the name for the file that will be written by this annotation processor.
void	init(ProcessingEnvironment processingEnv)
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
abstract void	processElement(Element element) This method will be called for each component class found by this processor.

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClassListPropertyFile

public ClassListPropertyFile()

Method Detail

getFileName

public abstract String getFileName()

Gets the name for the file that will be written by this annotation processor.

Returns:

The name of the file for this annotation processor.

processElement

public abstract void processElement(Element element)
                             throws IOException

This method will be called for each component class found by this processor. the implementation of this method must call the appendClass method to write the component reference to de file.

Parameters:

element - The element representing the current component class.

Throws:

IOException - If the component cannot be written to the file.

init

public void init(ProcessingEnvironment processingEnv)

Specified by:

init in interface Processor

Overrides:

init in class AbstractProcessor

process

public boolean process(Set<? extends TypeElement> annotations,
                       RoundEnvironment roundEnv)

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

appendProperty

protected void appendProperty(String key,
                              String value)
                       throws IOException

This method appends key=value to the output file.

Parameters:

key - The full class name of the component to append

value - The scope of the component

Throws:

IOException - If any IO error prevents the writing.