SakerProcessingEnvironment

package saker.java.compiler.api.processing

public interface SakerProcessingEnvironment extends ProcessingEnvironment

saker.java.compiler.api.processing.SakerProcessingEnvironment

javax.annotation.processing.ProcessingEnvironment

Describes the processing environment functionality provided by the incremental Java compiler.

The ProcessingEnvironment instance can be downcasted to SakerProcessingEnvironment during annotation processing.

The interface provides access to the name of the current source version enumeration that can avoid unexpected exceptions when the annotation processing and compilation are being done in a separate JVM.

Processor.init(ProcessingEnvironment)

Methods

public SakerElementsTypes	getElementUtils() Returns an implementation of some utility methods for operating on elements
public SakerFiler	getFiler() Returns the filer used to create new source, class, or auxiliary files.
public SakerMessager	getMessager() Returns the messager used to report errors, warnings, and other notices.
public SourceVersion	getSourceVersion() Returns the source version that any generated source and class files should conform to.
public String	getSourceVersionName() Gets the name of the SourceVersion value returned by getSourceVersion().
public SakerElementsTypes	getTypeUtils() Returns an implementation of some utility methods for operating on types.

Inherited methods
From: ProcessingEnvironment getElementUtils, getFiler, getLocale, getMessager, getOptions, getTypeUtils

public abstract SakerElementsTypes getElementUtils()

Overridden from: ProcessingEnvironment

Returns an implementation of some utility methods for operating on elements

element utilities

public abstract SakerFiler getFiler()

Overridden from: ProcessingEnvironment

Returns the filer used to create new source, class, or auxiliary files.

the filer

public abstract SakerMessager getMessager()

Overridden from: ProcessingEnvironment

Returns the messager used to report errors, warnings, and other notices.

the messager

public abstract SourceVersion getSourceVersion() throws SourceVersionNotFoundException

Returns the source version that any generated source and class files should conform to.

the source version to which generated source and class files should conform to

SourceVersionNotFoundExceptionIf the source version doesn't have an associated enum value in the current JVM. The name of the enum will be the message of the thrown exception.
It is recommended that callers attempt to catch an IllegalArgumentException instead, to avoid any class loading related versioning issues.

getSourceVersionName()

public abstract String getSourceVersionName()

Gets the name of the SourceVersion value returned by getSourceVersion().

This method serves the compatibility support when processing sources of a higher language model that can be represented in the current JVM.

E.g. if the compilation source version is RELEASE_9, and the current JVM has the version 8, then the SourceVersion.RELEASE_9 doesn't exist in the current JVM, therefore SourceVersion.valueOf(String) would throw an IllegalArgumentException. This method returns the name of the SourceVersion enum that would be returned by getSourceVersion().

The name of the SourceVersion enum value.

Enum.name()

public abstract SakerElementsTypes getTypeUtils()

Overridden from: ProcessingEnvironment

Returns an implementation of some utility methods for operating on types.

type utilities