org.checkerframework.framework.stub

Class StubParser

java.lang.Object

org.checkerframework.framework.stub.StubParser

public class StubParser
extends Object

Given a stub file, yields the annotated types in it and the declaration annotations in it. The main entry point is parse(String, InputStream, AnnotatedTypeFactory, ProcessingEnvironment, Map, Map), which side-effects its last two arguments.

The constructor acts in two parts. First, it calls the Stub Parser to parse a stub file. Then, itis walks the Stub Parser's AST to create/collect types and declaration annotations.

Constructor Summary

Constructors

Constructor and Description
StubParser(String filename, AnnotatedTypeFactory atypeFactory, ProcessingEnvironment processingEnv, Map<Element,AnnotatedTypeMirror> atypes, Map<String,Set<AnnotationMirror>> declAnnos, boolean isJdkAsStub) Create a new StubParser object, which will parse and extract annotations from the given stub file.

Method Summary

Modifier and Type	Method and Description
static void	parse(String filename, InputStream inputStream, AnnotatedTypeFactory atypeFactory, ProcessingEnvironment processingEnv, Map<Element,AnnotatedTypeMirror> atypes, Map<String,Set<AnnotationMirror>> declAnnos) The main entry point.
static void	parseJdkFileAsStub(String filename, InputStream inputStream, AnnotatedTypeFactory atypeFactory, ProcessingEnvironment processingEnv, Map<Element,AnnotatedTypeMirror> atypes, Map<String,Set<AnnotationMirror>> declAnnos) Parse a stub file that is a part of the annotated jdk and side-effects the last two arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

StubParser

public StubParser(String filename,
                  AnnotatedTypeFactory atypeFactory,
                  ProcessingEnvironment processingEnv,
                  Map<Element,AnnotatedTypeMirror> atypes,
                  Map<String,Set<AnnotationMirror>> declAnnos,
                  boolean isJdkAsStub)

Create a new StubParser object, which will parse and extract annotations from the given stub file.

Parameters:

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

atypeFactory - AnnotatedtypeFactory to use

processingEnv - ProcessingEnviroment to use

isJdkAsStub - whether or not the stub file is a part of the JDK

Method Detail

parse

public static void parse(String filename,
                         InputStream inputStream,
                         AnnotatedTypeFactory atypeFactory,
                         ProcessingEnvironment processingEnv,
                         Map<Element,AnnotatedTypeMirror> atypes,
                         Map<String,Set<AnnotationMirror>> declAnnos)

The main entry point. Parse a stub file 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 - ProcessingEnviroment to use

atypes - annotated types from this stub file is added to this map

declAnnos - declaration annotations from this stub file are added to this map

parseJdkFileAsStub

public static void parseJdkFileAsStub(String filename,
                                      InputStream inputStream,
                                      AnnotatedTypeFactory atypeFactory,
                                      ProcessingEnvironment processingEnv,
                                      Map<Element,AnnotatedTypeMirror> atypes,
                                      Map<String,Set<AnnotationMirror>> declAnnos)

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 - ProcessingEnviroment to use

atypes - annotated types from this stub file is added to this map

declAnnos - declaration annotations from this stub file are added to this map