com.bluegosling.apt

Class ProcessingEnvironments

java.lang.Object

com.bluegosling.apt.ProcessingEnvironments

public final class ProcessingEnvironments
extends Object

Static helper methods related to the current processing environment.

The current environment must be setup for the current thread. After that, processing code running on that same thread can conveniently access the environment and the Elements and Types utility interfaces using static methods on this class.

Method Summary

Modifier and Type	Method and Description
static Elements	elements() Gets the current implementation of utility methods relating to elements.
static ProcessingEnvironment	get() Gets the environment for the current thread.
static void	reset() Resets the current thread, clearing thread-local state related to the current environment.
static void	setup(ProcessingEnvironment env) Sets up the environment for the current thread.
static Types	types() Gets the current implementation of utility methods relating to types.

Methods inherited from class java.lang.Object

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

Method Detail

reset

public static void reset()

Resets the current thread, clearing thread-local state related to the current environment. This can only be called after the state has been setup(javax.annotation.processing.ProcessingEnvironment) on this thread.

Throws:

IllegalStateException - if the environment has not been setup on this thread

setup

public static void setup(ProcessingEnvironment env)

Sets up the environment for the current thread. This initializes thread-local state so that the environment can be conveniently accessed from other static methods.

Parameters:

env - the current processing environment

Throws:

IllegalStateException - if the environment has already been setup on this thread

get

public static ProcessingEnvironment get()

Gets the environment for the current thread.

Returns:

the processing environment for the current thread

Throws:

IllegalStateException - if the environment has not been setup on this thread

elements

public static Elements elements()

Gets the current implementation of utility methods relating to elements. This convenience method is short for ProcessingEnvironments.get().getElementUtils().

Returns:

the implementation of element utility methods for the current thread

Throws:

IllegalStateException - if the environment has not been setup on this thread

types

public static Types types()

Gets the current implementation of utility methods relating to types. This convenience method is short for ProcessingEnvironments.get().getTypeUtils().

Returns:

the implementation of type utility methods for the current thread

Throws:

IllegalStateException - if the environment has not been setup on this thread