org.checkerframework.framework.stub

Class AnnotationFileParser

java.lang.Object

org.checkerframework.framework.stub.AnnotationFileParser

public class AnnotationFileParser
extends Object

This class has three static methods. Each method parses an annotation file and adds annotations to the AnnotationFileParser.AnnotationFileAnnotations passed as an argument.

The first main entry point is parseStubFile(String, InputStream, AnnotatedTypeFactory, ProcessingEnvironment, AnnotationFileAnnotations, AnnotationFileUtil.AnnotationFileType, AnnotationFileElementTypes), which side-effects its last argument. It operates in two steps. First, it calls the Annotation File Parser to parse an annotation file. Then, it walks the AST to create/collect types and declaration annotations.

The second main entry point is parseAjavaFile(String, InputStream, CompilationUnitTree, AnnotatedTypeFactory, ProcessingEnvironment, AnnotationFileAnnotations, AnnotationFileElementTypes). This behaves the same as parseStubFile(String, InputStream, AnnotatedTypeFactory, ProcessingEnvironment, AnnotationFileAnnotations, AnnotationFileUtil.AnnotationFileType, AnnotationFileElementTypes), but takes an ajava file instead.

The other entry point is parseJdkFileAsStub(java.lang.String, java.io.InputStream, org.checkerframework.framework.type.AnnotatedTypeFactory, javax.annotation.processing.ProcessingEnvironment, org.checkerframework.framework.stub.AnnotationFileParser.AnnotationFileAnnotations, org.checkerframework.framework.stub.AnnotationFileElementTypes).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnnotationFileParser.AnnotationFileAnnotations The result of calling AnnotationFileParser.parse: the annotated types and declaration annotations from the file.
static class	AnnotationFileParser.AnnotationFileParserException An exception indicating a problem while parsing an annotation file.
static class	AnnotationFileParser.RecordComponentStub Information about a record component: its type, and whether there was an accessor in the stubs for that component.
static class	AnnotationFileParser.RecordStub Information about a record from a stub file.

Method Summary

Modifier and Type	Method and Description
static Map<String,TypeElement>	annosInPackage(PackageElement packageElement) All annotations defined in the package (but not those nested within classes in the package).
static Map<String,TypeElement>	annosInType(TypeElement typeElement) All annotations declared (directly) within a class.
static Map<String,TypeElement>	createNameToAnnotationMap(List<TypeElement> typeElements) All annotations declared within any of the given elements.
static void	parseAjavaFile(String filename, InputStream inputStream, CompilationUnitTree root, AnnotatedTypeFactory atypeFactory, ProcessingEnvironment processingEnv, AnnotationFileParser.AnnotationFileAnnotations ajavaAnnos, AnnotationFileElementTypes fileElementTypes) The main entry point when parsing an ajava file.
static void	parseJdkFileAsStub(String filename, InputStream inputStream, AnnotatedTypeFactory atypeFactory, ProcessingEnvironment processingEnv, AnnotationFileParser.AnnotationFileAnnotations stubAnnos, AnnotationFileElementTypes fileElementTypes) Parse a stub file that is a part of the annotated JDK and side-effects the stubAnnos argument.
static void	parseStubFile(String filename, InputStream inputStream, AnnotatedTypeFactory atypeFactory, ProcessingEnvironment processingEnv, AnnotationFileParser.AnnotationFileAnnotations annotationFileAnnos, AnnotationFileUtil.AnnotationFileType fileType, AnnotationFileElementTypes fileElementTypes) The main entry point.
static <K,V> void	putAllNew(Map<K,V> m, Map<K,V> m2) Just like Map.putAll, but modifies existing values using putIfAbsent(Map, Object, Object).
static <K,V> void	putIfAbsent(Map<K,V> m, K key, V value) Just like Map.put, but does not override any existing value in the map.

Methods inherited from class java.lang.Object

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

Method Detail

annosInPackage

public static Map<String,TypeElement> annosInPackage(PackageElement packageElement)

All annotations defined in the package (but not those nested within classes in the package). Keys are both fully-qualified and simple names.

Parameters:

packageElement - a package

Returns:

a map from annotation name to TypeElement

annosInType

public static Map<String,TypeElement> annosInType(TypeElement typeElement)

All annotations declared (directly) within a class. Keys are both fully-qualified and simple names.

Parameters:

typeElement - a type

Returns:

a map from annotation name to TypeElement

createNameToAnnotationMap

public static Map<String,TypeElement> createNameToAnnotationMap(List<TypeElement> typeElements)

All annotations declared within any of the given elements.

Parameters:

typeElements - the elements whose annotations to retrieve

Returns:

a map from annotation names (both fully-qualified and simple names) to TypeElement

parseStubFile

public static void parseStubFile(String filename,
                                 InputStream inputStream,
                                 AnnotatedTypeFactory atypeFactory,
                                 ProcessingEnvironment processingEnv,
                                 AnnotationFileParser.AnnotationFileAnnotations annotationFileAnnos,
                                 AnnotationFileUtil.AnnotationFileType fileType,
                                 AnnotationFileElementTypes fileElementTypes)

The main entry point. Parse a stub file and side-effects the annotationFileAnnos argument.

Parameters:

filename - name of stub file, used only for diagnostic messages

inputStream - of stub file to parse

atypeFactory - AnnotatedTypeFactory to use

processingEnv - ProcessingEnvironment to use

annotationFileAnnos - annotations from the annotation file; side-effected by this method

fileType - the annotation file type and source

fileElementTypes - the manager that controls the stub file parsing process

parseAjavaFile

public static void parseAjavaFile(String filename,
                                  InputStream inputStream,
                                  CompilationUnitTree root,
                                  AnnotatedTypeFactory atypeFactory,
                                  ProcessingEnvironment processingEnv,
                                  AnnotationFileParser.AnnotationFileAnnotations ajavaAnnos,
                                  AnnotationFileElementTypes fileElementTypes)

The main entry point when parsing an ajava file. Parses an ajava file and side-effects the last two arguments.

Parameters:

filename - name of ajava file, used only for diagnostic messages

inputStream - of ajava file to parse

root - javac tree for the file to be parsed

atypeFactory - AnnotatedTypeFactory to use

processingEnv - ProcessingEnvironment to use

ajavaAnnos - annotations from the ajava file; side-effected by this method

fileElementTypes - the manager that controls the stub file parsing process

parseJdkFileAsStub

public static void parseJdkFileAsStub(String filename,
                                      InputStream inputStream,
                                      AnnotatedTypeFactory atypeFactory,
                                      ProcessingEnvironment processingEnv,
                                      AnnotationFileParser.AnnotationFileAnnotations stubAnnos,
                                      AnnotationFileElementTypes fileElementTypes)

Parse a stub file that is a part of the annotated JDK and side-effects the stubAnnos argument.

Parameters:

filename - name of stub file, used only for diagnostic messages

inputStream - of stub file to parse

atypeFactory - AnnotatedTypeFactory to use

processingEnv - ProcessingEnvironment to use

stubAnnos - annotations from the stub file; side-effected by this method

fileElementTypes - the manager that controls the stub file parsing process

putIfAbsent

public static <K,V> void putIfAbsent(Map<K,V> m,
                                     K key,
                                     V value)

Just like Map.put, but does not override any existing value in the map.

Type Parameters:

K - the key type

V - the value type

Parameters:

m - a map

key - a key

value - the value to associate with the key, if the key isn't already in the map

putAllNew

public static <K,V> void putAllNew(Map<K,V> m,
                                   Map<K,V> m2)

Just like Map.putAll, but modifies existing values using putIfAbsent(Map, Object, Object).

Type Parameters:

K - the key type for the maps

V - the value type for the maps

Parameters:

m - the destination map

m2 - the source map