org.checkerframework.framework.stub

Class StubParser

java.lang.Object

org.checkerframework.framework.stub.StubParser

public class StubParser
extends Object

This class has two static methods. Each method parses a stub file and adds annotations to two maps passed as arguments.

The main entry point is parse(String, InputStream, AnnotatedTypeFactory, ProcessingEnvironment, Map, Map), which side-effects its last two arguments. It operates in two steps. First, it calls the Stub Parser to parse a stub file. Then, it walks the Stub Parser's 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, java.util.Map<javax.lang.model.element.Element, org.checkerframework.framework.type.AnnotatedTypeMirror>, java.util.Map<java.lang.String, java.util.Set<javax.lang.model.element.AnnotationMirror>>).

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

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

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

declAnnos - map from a name (actually declaration element string) to the set of declaration annotations on it. 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 - ProcessingEnvironment to use

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

declAnnos - map from a name (actually declaration element string) to the set of declaration annotations on it. Declaration annotations from this stub file are added to this map.