org.checkerframework.framework.stub

Class AnnotationFileParser

java.lang.Object

org.checkerframework.framework.stub.AnnotationFileParser

public class AnnotationFileParser
extends Object

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

The main entry point is parseStubFile(String, InputStream, AnnotatedTypeFactory, ProcessingEnvironment, AnnotationFileAnnotations), 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 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).

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.

Method Summary

Modifier and Type	Method and Description
static void	parseJdkFileAsStub(String filename, InputStream inputStream, AnnotatedTypeFactory atypeFactory, ProcessingEnvironment processingEnv, AnnotationFileParser.AnnotationFileAnnotations stubAnnos) Parse a stub file that is a part of the annotated JDK and side-effects the last two arguments.
static void	parseStubFile(String filename, InputStream inputStream, AnnotatedTypeFactory atypeFactory, ProcessingEnvironment processingEnv, AnnotationFileParser.AnnotationFileAnnotations annotationFileAnnos) The main entry point.

Methods inherited from class java.lang.Object

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

Method Detail

parseStubFile

public static void parseStubFile(String filename,
                                 InputStream inputStream,
                                 AnnotatedTypeFactory atypeFactory,
                                 ProcessingEnvironment processingEnv,
                                 AnnotationFileParser.AnnotationFileAnnotations annotationFileAnnos)

The main entry point. Parse a stub file and side-effects the last 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

parseJdkFileAsStub

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

Parse a stub file that is a part of the annotated JDK and side-effects the last two arguments.

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