xdean.annotation.processor.toolkit

类 XAbstractProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

xdean.annotation.processor.toolkit.XAbstractProcessor

所有已实现的接口:

Processor, CommonUtil

public abstract class XAbstractProcessor
extends AbstractProcessor
implements CommonUtil

An more powerful abstract annotation processor designed to be a convenient superclass for most concrete annotation processors.

Differences with AbstractProcessor:

• Use SupportedAnnotation to define supported annotation by Class instead of String
• Assert methods for quick exit rather than check and return
• Convenient access to common utilities and log

作者:

XDean

嵌套类概要

嵌套类

限定符和类型	类和说明
protected static class	XAbstractProcessor.Assert<T> ASSERT
protected class	XAbstractProcessor.Log

从接口继承的嵌套类/接口 xdean.annotation.processor.toolkit.CommonUtil

CommonUtil.ActionE0<E extends Exception>, CommonUtil.FuncE0<R,E extends Exception>

字段概要

字段

限定符和类型	字段和说明
protected Elements	elements
protected Filer	filer
protected boolean	isDebug
protected Messager	messager
protected Types	types

从类继承的字段 javax.annotation.processing.AbstractProcessor

processingEnv

构造器概要

构造器

构造器和说明
XAbstractProcessor()

方法概要

限定符和类型	方法和说明
protected <T> XAbstractProcessor.Assert<T>	assertDo(Callable<T> task)
protected <T> XAbstractProcessor.Assert<T>	assertNonNull(T t)
protected XAbstractProcessor.Assert<Void>	assertThat(boolean b)
protected <T> XAbstractProcessor.Assert<T>	assertType(Object o, Class<T> clz)
protected XAbstractProcessor.Log	debug() LOG
protected XAbstractProcessor.Log	error()
Set<String>	getSupportedAnnotationTypes() If the processor class is annotated with SupportedAnnotation or SupportedAnnotationTypes, return an unmodifiable set with the same set of strings as the annotation.
protected void	handleAssert(Runnable task) Override this method to do something for AssertException.
void	init(ProcessingEnvironment processingEnv)
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) Use processActual(Set, RoundEnvironment)
abstract boolean	processActual(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) Processes a set of annotation types on type elements originating from the prior round and returns whether or not these annotation types are claimed by this processor.
protected XAbstractProcessor.Log	warning()

从类继承的方法 javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedOptions, getSupportedSourceVersion, isInitialized

从类继承的方法 java.lang.Object

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

从接口继承的方法 xdean.annotation.processor.toolkit.CommonUtil

ensureFileSystem, getStackTraceString, throwAsUncheck, uncatch, uncheck, uncheck

字段详细资料

types

protected Types types

elements

protected Elements elements

messager

protected Messager messager

filer

protected Filer filer

isDebug

protected boolean isDebug

构造器详细资料

XAbstractProcessor

public XAbstractProcessor()

方法详细资料

init

public void init(ProcessingEnvironment processingEnv)

指定者:

init 在接口中 Processor

覆盖:

init 在类中 AbstractProcessor

process

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

Use processActual(Set, RoundEnvironment)

指定者:

process 在接口中 Processor

指定者:

process 在类中 AbstractProcessor

processActual

public abstract boolean processActual(Set<? extends TypeElement> annotations,
                                      RoundEnvironment roundEnv)
                               throws AssertException

Processes a set of annotation types on type elements originating from the prior round and returns whether or not these annotation types are claimed by this processor. If true is returned, the annotation types are claimed and subsequent processors will not be asked to process them; if false is returned, the annotation types are unclaimed and subsequent processors may be asked to process them. A processor may always return the same boolean value or may vary the result based on chosen criteria.

The input set will be empty if the processor supports "*" and the root elements have no annotations. A Processor must gracefully handle an empty set of annotations.

参数:

annotations - the annotation types requested to be processed

roundEnv - environment for information about the current and prior round

返回:

whether or not the set of annotation types are claimed by this processor

抛出:

AssertException - throw the AssertException to quit the process directly

另请参阅:

assertThat(boolean), handleAssert(Runnable)

handleAssert

protected void handleAssert(Runnable task)

Override this method to do something for AssertException.
The default behavior is log the message as error if present.

参数:

task - task who will throw AssertException

getSupportedAnnotationTypes

public Set<String> getSupportedAnnotationTypes()

If the processor class is annotated with SupportedAnnotation or SupportedAnnotationTypes, return an unmodifiable set with the same set of strings as the annotation. If the class is not so annotated, an empty set is returned.

指定者:

getSupportedAnnotationTypes 在接口中 Processor

覆盖:

getSupportedAnnotationTypes 在类中 AbstractProcessor

assertThat

protected XAbstractProcessor.Assert<Void> assertThat(boolean b)

assertType

protected <T> XAbstractProcessor.Assert<T> assertType(Object o,
                                                      Class<T> clz)

assertNonNull

protected <T> XAbstractProcessor.Assert<T> assertNonNull(T t)

assertDo

protected <T> XAbstractProcessor.Assert<T> assertDo(Callable<T> task)

debug

protected XAbstractProcessor.Log debug()

LOG

warning

protected XAbstractProcessor.Log warning()

error

protected XAbstractProcessor.Log error()