org.jboss.logging
Class AbstractTool

java.lang.Object
  org.jboss.logging.AbstractTool

Direct Known Subclasses:

ImplementorClassGenerator, TranslationClassGenerator, TranslationFileGenerator

public abstract class AbstractTool
extends Object

An abstract processor used process annotations.

Author:

James R. Perkins, Kevin Pollet - SERLI - (kevin.pollet@serli.com)

Constructor Summary

AbstractTool(ProcessingEnvironment processingEnv)
Constructs a new processor.

Method Summary

Elements	elementUtils() Returns the element utils.
Filer	filer() Returns the filer.
String	getName() Returns the name of the processor.
Set<String>	getSupportedOptions() Returns the supported options set.
ToolLogger	logger() Returns the logger to log messages with.
ProcessingEnvironment	processingEnv() Returns the processing environment.
abstract void	processTypeElement(TypeElement annotation, TypeElement element, MethodDescriptors methodDescriptor) Processes a type element.
Types	typeUtils() Returns the type utils.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTool

public AbstractTool(ProcessingEnvironment processingEnv)

Constructs a new processor.

Parameters:

processingEnv - the processing environment.

Method Detail

processTypeElement

public abstract void processTypeElement(TypeElement annotation,
                                        TypeElement element,
                                        MethodDescriptors methodDescriptor)

Processes a type element.

Parameters:

annotation - the annotation who trigger the processing

element - the element that contains the methods.

methodDescriptor - the method descriptors.

logger

public final ToolLogger logger()

Returns the logger to log messages with.

Returns:

the logger to log messages with.

filer

public final Filer filer()

Returns the filer.

Returns:

the filer

elementUtils

public final Elements elementUtils()

Returns the element utils.

Returns:

the utils

typeUtils

public final Types typeUtils()

Returns the type utils.

Returns:

the utils

processingEnv

public final ProcessingEnvironment processingEnv()

Returns the processing environment.

Returns:

the processing environment being used.

getName

public final String getName()

Returns the name of the processor.

Returns:

the name of the processor.

getSupportedOptions

public final Set<String> getSupportedOptions()

Returns the supported options set.

Returns:

the supported options set or empty set if none