Package io.determann.shadow.api

Interface ShadowApi

All Superinterfaces:

ApiHolder, DeclaredHolder

All Known Implementing Classes:

ShadowApiImpl

public interface ShadowApi
extends DeclaredHolder

This is the core class for a lightweight wrapper around the java annotationProcessor api. The ShadowApi is transient. Meaning you can transition between using the shadow and the java annotation processor api from line to line if you so wish. Methods in the ShadowApi that leak the annotation processor api are annotated with JdkApi.

Usage:

• get anything that is annotated getAnnotatedWith(String)
• get already compiled sources DeclaredHolder.getDeclaredOrThrow(String) for example
• get constants getConstants()
• log using logError(String) or log at logErrorAt(ElementBacked, String)
• convert between sourceCode representations. So called Shadows convert(Shadow)

See Also:

• ShadowProcessor
• JdkApi
• Shadow

Method Summary

Modifier and Type	Method	Description
static AnnotationConverter	convert(Annotation annotationShadow)
static ArrayConverter	convert(Array array)
static ClassConverter	convert(Class aClass)
static ConstructorConverter	convert(Constructor constructor)
static DeclaredConverter	convert(Declared declared)
static EnumConverter	convert(Enum enumShadow)
static EnumConstantConverter	convert(EnumConstant enumConstant)
static ExecutableConverter	convert(Executable executable)
static FieldConverter	convert(Field field)
static GenericConverter	convert(Generic generic)
static InterfaceConverter	convert(Interface interfaceShadow)
static IntersectionConverter	convert(Intersection intersection)
static MethodConverter	convert(Method methodShadow)
static ModuleConverter	convert(Module module)
static DirectiveConverter	convert(Directive directive)
static ExportsConverter	convert(Exports exportsShadow)
static OpensConverter	convert(Opens opensShadow)
static ProvidesConverter	convert(Provides providesShadow)
static RequiresConverter	convert(Requires requiresShadow)
static UsesConverter	convert(Uses usesShadow)
static NullConverter	convert(Null aNull)
static PackageConverter	convert(Package packageShadow)
static ParameterConverter	convert(Parameter parameter)
static PrimitiveConverter	convert(Primitive primitive)
static RecordConverter	convert(Record recordShadow)
static RecordComponentConverter	convert(RecordComponent recordComponent)
static ShadowConverter	convert(Shadow<? extends TypeMirror> shadow)
static VariableConverter	convert(Variable<?> variable)
static VoidConverter	convert(Void aVoid)
static WildcardConverter	convert(Wildcard wildcard)
static ShadowApi	create(ShadowApi apiFromPreviousRound, ProcessingEnvironment processingEnv, RoundEnvironment roundEnv, int processingRound)
static ShadowApi	create(ProcessingEnvironment processingEnv, RoundEnvironment roundEnv, int processingRound)
static Declared	erasure(Declared declared)	Convince method that performs erasure on all declared types that support it
AnnotationTypeChooser	getAnnotatedWith(Annotation annotation)	Looks up annotated elements in currently compiled code.
AnnotationTypeChooser	getAnnotatedWith(String qualifiedAnnotation)	Looks up annotated elements in currently compiled code.
ShadowConstants	getConstants()
java.util.function.BiConsumer<ShadowApi,DiagnosticContext>	getDiagnosticHandler()
java.util.function.BiConsumer<ShadowApi,Throwable>	getExceptionHandler()
JdkApiContext	getJdkApiContext()
Optional<Module>	getModule(String name)
Module	getModuleOrThrow(String name)
List<Module>	getModules()
Optional<Package>	getPackage(Module module, String qualifiedPackageName)
Optional<Package>	getPackage(String qualifiedModuleName, String qualifiedPackageName)
Package	getPackageOrThrow(Module module, String qualifiedPackageName)
Package	getPackageOrThrow(String qualifiedModuleName, String qualifiedPackageName)
List<Package>	getPackages()
List<Package>	getPackages(String qualifiedName)	a package is unique per module.
int	getProcessingRound()	starts at 0
ShadowFactory	getShadowFactory()
java.util.function.BiConsumer<ShadowApi,String>	getSystemErrorHandler()
java.util.function.BiConsumer<ShadowApi,String>	getSystemOutHandler()
boolean	isFirstRound()	First round of annotation processing
boolean	isProcessingOver()	Last round of annotation processing
void	logError(String msg)
void	logErrorAt(ElementBacked<?> elementBacked, String msg)
void	logInfo(String msg)
void	logInfoAt(ElementBacked<?> elementBacked, String msg)
void	logWarning(String msg)
void	logWarningAt(ElementBacked<?> elementBacked, String msg)
void	onNameRendered(java.util.function.Consumer<NameRenderedEvent> onNameRendered)
FileObject	readResource(StandardLocation location, String moduleAndPkg, String relativPath)
static AnnotationRenderer	render(Annotation annotation)
static AnnotationUsageRenderer	render(AnnotationUsage annotationUsage)
static ArrayRenderer	render(Array array)
static ClassRenderer	render(Class clazz)
static ConstructorRenderer	render(Constructor constructor)
static EnumRenderer	render(Enum enumType)
static EnumConstantRenderer	render(EnumConstant enumConstant)
static FieldRenderer	render(Field field)
static GenericRenderer	render(Generic generic)
static InterfaceRenderer	render(Interface interfaceType)
static IntersectionRenderer	render(Intersection intersection)
static MethodRenderer	render(Method method)
static ModuleRenderer	render(Module module)
static PackageRenderer	render(Package packageType)
static ParameterRenderer	render(Parameter parameter)
static PrimitiveRenderer	render(Primitive primitive)
static RecordRenderer	render(Record recordType)
static RecordComponentRenderer	render(RecordComponent recordComponent)
static WildcardRenderer	render(Wildcard wildcard)
void	renderNamesWithoutNeedingImports()	all render methods produce qualified names except for the content of java.lang.
void	renderQualifiedNames()	all render methods produce qualified names default is renderNamesWithoutNeedingImports()
void	renderSimpleNames()	all render methods produce simple names.
void	setDiagnosticHandler(java.util.function.BiConsumer<ShadowApi,DiagnosticContext> diagnosticHandler)	Executed at the end of each round.
void	setExceptionHandler(java.util.function.BiConsumer<ShadowApi,Throwable> exceptionHandler)	Consumer to handle exceptions that occur in this annotation processor.
void	setSystemErrorHandler(java.util.function.BiConsumer<ShadowApi,String> systemErrorHandler)	Some Tool don't support System.err.
void	setSystemOutHandler(java.util.function.BiConsumer<ShadowApi,String> systemOutHandler)	Some Tool don't support System.out.
void	writeClassFile(String qualifiedName, String content)	the created file will be registered for the next annotation processor round. writes .class files
void	writeResource(StandardLocation location, String moduleAndPkg, String relativPath, String content)	the created file will NOT be registered for the next annotation processor round. writes anything
void	writeSourceFile(String qualifiedName, String content)	the created file will be registered for the next annotation processor round. writes .java files

Methods inherited from interface io.determann.shadow.api.ApiHolder

getApi

Methods inherited from interface io.determann.shadow.api.DeclaredHolder

getAnnotation, getAnnotationOrThrow, getAnnotations, getClass, getClasses, getClassOrThrow, getDeclared, getDeclared, getDeclaredOrThrow, getEnum, getEnumOrThrow, getEnums, getInterface, getInterfaceOrThrow, getInterfaces, getRecord, getRecordOrThrow, getRecords

Method Details

create

static ShadowApi create(ProcessingEnvironment processingEnv,
 RoundEnvironment roundEnv,
 int processingRound)

create

static ShadowApi create(ShadowApi apiFromPreviousRound,
 ProcessingEnvironment processingEnv,
 RoundEnvironment roundEnv,
 int processingRound)

getJdkApiContext

JdkApiContext getJdkApiContext()

getAnnotatedWith

AnnotationTypeChooser getAnnotatedWith(String qualifiedAnnotation)

Looks up annotated elements in currently compiled code.
Annotation processing happens in rounds. If a processor generates sources the next round will contain only these.

See Also:

• writeSourceFile(String, String)
• writeClassFile(String, String)

getAnnotatedWith

AnnotationTypeChooser getAnnotatedWith(Annotation annotation)

Looks up annotated elements in currently compiled code.
Annotation processing happens in rounds. If a processor generates sources the next round will contain only these.

See Also:

• writeSourceFile(String, String)
• writeClassFile(String, String)

getModules

List<Module> getModules()

getModule

Optional<Module> getModule(String name)

getModuleOrThrow

Module getModuleOrThrow(String name)

getPackages

List<Package> getPackages(String qualifiedName)

a package is unique per module. With multiple modules there can be multiple packages with the same name

getPackages

List<Package> getPackages()

getPackage

Optional<Package> getPackage(String qualifiedModuleName,
 String qualifiedPackageName)

getPackageOrThrow

Package getPackageOrThrow(String qualifiedModuleName,
 String qualifiedPackageName)

getPackage

Optional<Package> getPackage(Module module,
 String qualifiedPackageName)

getPackageOrThrow

Package getPackageOrThrow(Module module,
 String qualifiedPackageName)

getConstants

ShadowConstants getConstants()

getShadowFactory

ShadowFactory getShadowFactory()

logError

void logError(String msg)

logInfo

void logInfo(String msg)

logWarning

void logWarning(String msg)

logErrorAt

void logErrorAt(ElementBacked<?> elementBacked,
 String msg)

logInfoAt

void logInfoAt(ElementBacked<?> elementBacked,
 String msg)

logWarningAt

void logWarningAt(ElementBacked<?> elementBacked,
 String msg)

writeSourceFile

void writeSourceFile(String qualifiedName,
 String content)

the created file will be registered for the next annotation processor round. writes .java files

writeClassFile

void writeClassFile(String qualifiedName,
 String content)

the created file will be registered for the next annotation processor round. writes .class files

writeResource

void writeResource(StandardLocation location,
 String moduleAndPkg,
 String relativPath,
 String content)

the created file will NOT be registered for the next annotation processor round. writes anything

readResource

FileObject readResource(StandardLocation location,
 String moduleAndPkg,
 String relativPath)
                 throws IOException

Throws:

IOException

isProcessingOver

boolean isProcessingOver()

Last round of annotation processing

isFirstRound

boolean isFirstRound()

First round of annotation processing

getProcessingRound

int getProcessingRound()

starts at 0

setExceptionHandler

void setExceptionHandler(java.util.function.BiConsumer<ShadowApi,Throwable> exceptionHandler)

Consumer to handle exceptions that occur in this annotation processor. If you want the compilation to stop because of it just throw any expedition.

getExceptionHandler

java.util.function.BiConsumer<ShadowApi,Throwable> getExceptionHandler()

See Also:

• setExceptionHandler(BiConsumer)

setDiagnosticHandler

void setDiagnosticHandler(java.util.function.BiConsumer<ShadowApi,DiagnosticContext> diagnosticHandler)

Executed at the end of each round. When the processing is over each Processor gets called one more time with isProcessingOver() = true.

getDiagnosticHandler

java.util.function.BiConsumer<ShadowApi,DiagnosticContext> getDiagnosticHandler()

See Also:

• setDiagnosticHandler(BiConsumer)

setSystemOutHandler

void setSystemOutHandler(java.util.function.BiConsumer<ShadowApi,String> systemOutHandler)

Some Tool don't support System.out. By default, it is proxied and redirected to the logger as warning

getSystemOutHandler

java.util.function.BiConsumer<ShadowApi,String> getSystemOutHandler()

See Also:

• setSystemOutHandler(BiConsumer)

setSystemErrorHandler

void setSystemErrorHandler(java.util.function.BiConsumer<ShadowApi,String> systemErrorHandler)

Some Tool don't support System.err. By default, it is proxied and redirected to the logger as error during

getSystemErrorHandler

java.util.function.BiConsumer<ShadowApi,String> getSystemErrorHandler()

See Also:

• setSystemErrorHandler(BiConsumer)

erasure

static Declared erasure(Declared declared)

Convince method that performs erasure on all declared types that support it

See Also:

• Class.erasure()
• Interface.erasure()
• Record.erasure()

renderQualifiedNames

void renderQualifiedNames()

all render methods produce qualified names default is renderNamesWithoutNeedingImports()

See Also:

• renderSimpleNames()
• renderNamesWithoutNeedingImports()
• onNameRendered(Consumer)

renderSimpleNames

void renderSimpleNames()

all render methods produce simple names. default is renderNamesWithoutNeedingImports()

See Also:

• renderQualifiedNames()
• renderNamesWithoutNeedingImports()
• onNameRendered(Consumer)

renderNamesWithoutNeedingImports

void renderNamesWithoutNeedingImports()

all render methods produce qualified names except for the content of java.lang. this is the default

See Also:

• renderSimpleNames()
• renderQualifiedNames()
• onNameRendered(Consumer)

onNameRendered

void onNameRendered(java.util.function.Consumer<NameRenderedEvent> onNameRendered)

See Also:

• renderQualifiedNames()
• renderSimpleNames()
• renderNamesWithoutNeedingImports()

render

static AnnotationRenderer render(Annotation annotation)

render

static AnnotationUsageRenderer render(AnnotationUsage annotationUsage)

render

static ArrayRenderer render(Array array)

render

static ClassRenderer render(Class clazz)

render

static ConstructorRenderer render(Constructor constructor)

render

static EnumRenderer render(Enum enumType)

render

static EnumConstantRenderer render(EnumConstant enumConstant)

render

static FieldRenderer render(Field field)

render

static GenericRenderer render(Generic generic)

render

static InterfaceRenderer render(Interface interfaceType)

render

static IntersectionRenderer render(Intersection intersection)

render

static MethodRenderer render(Method method)

render

static ModuleRenderer render(Module module)

render

static PackageRenderer render(Package packageType)

render

static ParameterRenderer render(Parameter parameter)

render

static PrimitiveRenderer render(Primitive primitive)

render

static RecordRenderer render(Record recordType)

render

static RecordComponentRenderer render(RecordComponent recordComponent)

render

static WildcardRenderer render(Wildcard wildcard)

convert

static AnnotationConverter convert(Annotation annotationShadow)

convert

static ArrayConverter convert(Array array)

convert

static ClassConverter convert(Class aClass)

convert

static ConstructorConverter convert(Constructor constructor)

convert

static DeclaredConverter convert(Declared declared)

convert

static EnumConstantConverter convert(EnumConstant enumConstant)

convert

static EnumConverter convert(Enum enumShadow)

convert

static ExecutableConverter convert(Executable executable)

convert

static FieldConverter convert(Field field)

convert

static InterfaceConverter convert(Interface interfaceShadow)

convert

static IntersectionConverter convert(Intersection intersection)

convert

static MethodConverter convert(Method methodShadow)

convert

static ModuleConverter convert(Module module)

convert

static VoidConverter convert(Void aVoid)

convert

static NullConverter convert(Null aNull)

convert

static PackageConverter convert(Package packageShadow)

convert

static ParameterConverter convert(Parameter parameter)

convert

static PrimitiveConverter convert(Primitive primitive)

convert

static RecordComponentConverter convert(RecordComponent recordComponent)

convert

static RecordConverter convert(Record recordShadow)

convert

static ShadowConverter convert(Shadow<? extends TypeMirror> shadow)

convert

static GenericConverter convert(Generic generic)

convert

static VariableConverter convert(Variable<?> variable)

convert

static WildcardConverter convert(Wildcard wildcard)

convert

static DirectiveConverter convert(Directive directive)

convert

static ExportsConverter convert(Exports exportsShadow)

convert

static OpensConverter convert(Opens opensShadow)

convert

static ProvidesConverter convert(Provides providesShadow)

convert

static RequiresConverter convert(Requires requiresShadow)

convert

static UsesConverter convert(Uses usesShadow)