Package org.atteo.classindex.processor

Class ClassIndexProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.atteo.classindex.processor.ClassIndexProcessor

All Implemented Interfaces:

Processor

public class ClassIndexProcessor
extends AbstractProcessor

Generates index files for ClassIndex.

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String,Set<String>>	annotatedMap
private boolean	annotationDriven
private Elements	elementUtils
private Filer	filer
private Set<String>	indexedAnnotations
private Set<String>	indexedPackages
private Set<String>	indexedSuperclasses
private Set<TypeElement>	javadocAlreadyStored
private Messager	messager
private Map<String,Set<String>>	packageMap
private Map<String,Set<String>>	subclassMap
private Types	types

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Modifier	Constructor	Description
	ClassIndexProcessor()
protected	ClassIndexProcessor(Class<?>... classes)	Used when creating subclasses of the processor which will index some annotations which cannot be itself annotated with IndexAnnotated or IndexSubclasses.

Method Summary

Modifier and Type	Method	Description
private String	getFullName(TypeElement typeElement)
private PackageElement	getPackage(Element typeElement)
private String	getShortName(TypeElement typeElement)
Set<String>	getSupportedAnnotationTypes()
SourceVersion	getSupportedSourceVersion()
private boolean	hasAnnotation(TypeElement element, Class<? extends Annotation> inheritedClass)
protected final void	indexAnnotations(Class<?>... classes)	Adds given annotations for indexing.
protected final void	indexPackages(String... packages)	Adds given package for indexing.
protected final void	indexSubclasses(Class<?>... classes)	Adds given classes for subclass indexing.
private void	indexSupertypes(TypeElement rootElement, TypeElement element)	Index super types for IndexSubclasses and any IndexAnnotated additionally accompanied by Inherited.
void	init(ProcessingEnvironment processingEnv)
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
private <K> void	putElement(Map<K,Set<String>> map, K keyElement, String valueElement)
private <K> void	putElement(Map<K,Set<String>> map, K keyElement, TypeElement valueElement)
private static void	readOldIndexFile(Set<String> entries, Reader reader)
private FileObject	readOldIndexFile(Set<String> entries, String resourceName)
private void	storeAnnotation(TypeElement annotationElement, TypeElement rootElement)
private void	storeClassFromPackage(PackageElement packageElement, TypeElement rootElement)
private void	storeJavadoc(TypeElement element)
private void	storeRepeatableAnnotation(AnnotationMirror annotation, TypeElement typeElement)
private void	storeSubclass(TypeElement superTypeElement, TypeElement rootElement)
private void	writeFile(String content, String resourceName)
private void	writeIndexFile(Set<String> entries, String resourceName, FileObject overrideFile)
private void	writeIndexFiles(String prefix, Map<String,Set<String>> indexMap)
private void	writeSimpleNameIndexFile(Set<String> elementList, String resourceName)

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedOptions, isInitialized

Methods inherited from class java.lang.Object

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

Field Details

subclassMap

private Map<String,Set<String>> subclassMap

annotatedMap

private Map<String,Set<String>> annotatedMap

packageMap

private Map<String,Set<String>> packageMap

annotationDriven

private boolean annotationDriven

indexedAnnotations

private Set<String> indexedAnnotations

indexedSuperclasses

private Set<String> indexedSuperclasses

indexedPackages

private Set<String> indexedPackages

javadocAlreadyStored

private Set<TypeElement> javadocAlreadyStored

types

private Types types

filer

private Filer filer

elementUtils

private Elements elementUtils

messager

private Messager messager

Constructor Details

ClassIndexProcessor

public ClassIndexProcessor()

ClassIndexProcessor

protected ClassIndexProcessor(Class<?>... classes)

Used when creating subclasses of the processor which will index some annotations which cannot be itself annotated with IndexAnnotated or IndexSubclasses.

Parameters:

classes - list of classes which the processor will be indexing

Method Details

indexAnnotations

protected final void indexAnnotations(Class<?>... classes)

Adds given annotations for indexing.

indexSubclasses

protected final void indexSubclasses(Class<?>... classes)

Adds given classes for subclass indexing.

indexPackages

protected final void indexPackages(String... packages)

Adds given package for indexing.

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor

getSupportedAnnotationTypes

public Set<String> getSupportedAnnotationTypes()

Specified by:

getSupportedAnnotationTypes in interface Processor

Overrides:

getSupportedAnnotationTypes in class AbstractProcessor

init

public void init(ProcessingEnvironment processingEnv)

Specified by:

init in interface Processor

Overrides:

init in class AbstractProcessor

process

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

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

storeRepeatableAnnotation

private void storeRepeatableAnnotation(AnnotationMirror annotation,
 TypeElement typeElement)
                                throws IOException

Throws:

IOException

writeIndexFiles

private void writeIndexFiles(String prefix,
 Map<String,Set<String>> indexMap)
                      throws IOException

Throws:

IOException

readOldIndexFile

private FileObject readOldIndexFile(Set<String> entries,
 String resourceName)
                             throws IOException

Throws:

IOException

readOldIndexFile

private static void readOldIndexFile(Set<String> entries,
 Reader reader)
                              throws IOException

Throws:

IOException

writeIndexFile

private void writeIndexFile(Set<String> entries,
 String resourceName,
 FileObject overrideFile)
                     throws IOException

Throws:

IOException

writeSimpleNameIndexFile

private void writeSimpleNameIndexFile(Set<String> elementList,
 String resourceName)
                               throws IOException

Throws:

IOException

writeFile

private void writeFile(String content,
 String resourceName)
                throws IOException

Throws:

IOException

indexSupertypes

private void indexSupertypes(TypeElement rootElement,
 TypeElement element)
                      throws IOException

Index super types for IndexSubclasses and any IndexAnnotated additionally accompanied by Inherited.

Throws:

IOException

hasAnnotation

private boolean hasAnnotation(TypeElement element,
 Class<? extends Annotation> inheritedClass)

storeAnnotation

private void storeAnnotation(TypeElement annotationElement,
 TypeElement rootElement)
                      throws IOException

Throws:

IOException

storeSubclass

private void storeSubclass(TypeElement superTypeElement,
 TypeElement rootElement)
                    throws IOException

Throws:

IOException

storeClassFromPackage

private void storeClassFromPackage(PackageElement packageElement,
 TypeElement rootElement)
                            throws IOException

Throws:

IOException

putElement

private <K> void putElement(Map<K,Set<String>> map,
 K keyElement,
 TypeElement valueElement)

putElement

private <K> void putElement(Map<K,Set<String>> map,
 K keyElement,
 String valueElement)

getFullName

private String getFullName(TypeElement typeElement)

getShortName

private String getShortName(TypeElement typeElement)

getPackage

private PackageElement getPackage(Element typeElement)

storeJavadoc

private void storeJavadoc(TypeElement element)
                   throws IOException

Throws:

IOException