Interface ScanContext

All Superinterfaces:

CodegenContext

public interface ScanContext
extends CodegenContext

Classpath scanning code generation context.

Method Summary

Modifier and Type	Method	Description
io.github.classgraph.ScanResult	scanResult()	Scan result that should have types from the whole classpath.

Methods inherited from interface CodegenContext

annotationMappers, elementMappers, filer, logger, mapperSupportedAnnotationPackages, mapperSupportedAnnotations, module, moduleName, options, scope, supportedOptions, typeHierarchyResolver, typeInfo, typeInfo, typeMappers, uniqueName

Modifier and Type	Method	Description
List<AnnotationMapper>	annotationMappers()	List of available annotation mappers in this environment.
List<ElementMapper>	elementMappers()	List of available element mappers in this environment.
CodegenFiler	filer()	Filer to generate sources and resources.
CodegenLogger	logger()	Logger to log messages according to the environment we run in (Annotation processor, Maven plugin, command line).
Set<String>	mapperSupportedAnnotationPackages()	Annotation packages supported by the mappers.
Set<TypeName>	mapperSupportedAnnotations()	Annotations supported by the mappers.
Optional<ModuleInfo>	module()	Module that is being processed.
default Optional<String>	moduleName()	Configured module name using CodegenOptions.CODEGEN_MODULE, or name of the module if defined from CodegenContext.module(), or empty if not identified.
CodegenOptions	options()	Code generation options.
CodegenScope	scope()	Current code generation scope.
Set<Option<?>>	supportedOptions()	Codegen options supported by the mappers.
default TypeHierarchyResolver	typeHierarchyResolver(Function<TypeName, Optional<TypeInfo>> typeInfoLookup)	Creates the Java type hierarchy resolver for a processing round.
Optional<TypeInfo>	typeInfo(TypeName typeName)	Discover information about the provided type.
Optional<TypeInfo>	typeInfo(TypeName typeName, Predicate<TypedElementInfo> elementPredicate)	Discover information about the provided type, with a predicate for child elements.
List<TypeMapper>	typeMappers()	List of available type mappers in this environment.
String	uniqueName(TypeInfo type, TypedElementInfo element)	Get the unique name for the element within the provided type.

Method Details

scanResult

io.github.classgraph.ScanResult scanResult()

Scan result that should have types from the whole classpath.

Returns:

scan result