org.checkerframework.framework.stub

Class StubTypes

java.lang.Object

org.checkerframework.framework.stub.StubTypes

public class StubTypes
extends Object

Holds information about types parsed from stub files.

Constructor Summary

Constructors

Constructor and Description
StubTypes(AnnotatedTypeFactory factory) Creates a stub type.

Method Summary

Modifier and Type	Method and Description
AnnotatedTypeMirror	getAnnotatedTypeMirror(Element e) Returns the annotated type for e containing only annotations explicitly written in a stub file or null if e does not appear in a stub file.
Set<AnnotationMirror>	getDeclAnnotation(Element elt) Returns the set of declaration annotations for e containing only annotations explicitly written in a stub file or the empty set if e does not appear in a stub file.
boolean	isParsing() Returns true if stub files are currently being parsed; otherwise, false.
void	parseStubFiles() Parses the stub files in the following order: jdk.astub in the same directory as the checker, if it exists and ignorejdkastub option is not supplied If parsing a JDK as stub files, all package-info.java in the jdk directory Stub files listed in @StubFiles annotation on the checker; must be in same directory as the checker Stub files provide via stubs system property Stub files provide via stubs environment variable Stub files provide via stubs compiler option

Methods inherited from class java.lang.Object

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

Constructor Detail

StubTypes

public StubTypes(AnnotatedTypeFactory factory)

Creates a stub type.

Parameters:

factory - AnnotatedTypeFactory

Method Detail

isParsing

public boolean isParsing()

Returns true if stub files are currently being parsed; otherwise, false.

Returns:

true if stub files are currently being parsed; otherwise, false

parseStubFiles

public void parseStubFiles()

Parses the stub files in the following order:

1. jdk.astub in the same directory as the checker, if it exists and ignorejdkastub option is not supplied
   
2. If parsing a JDK as stub files, all package-info.java in the jdk directory
   
3. Stub files listed in @StubFiles annotation on the checker; must be in same directory as the checker
   
4. Stub files provide via stubs system property
   
5. Stub files provide via stubs environment variable
   
6. Stub files provide via stubs compiler option

If a type is annotated with a qualifier from the same hierarchy in more than one stub file, the qualifier in the last stub file is applied.

If using JDK 11, then the JDK stub files are only parsed if a type or declaration annotation is requested from a class in that file.

getAnnotatedTypeMirror

public AnnotatedTypeMirror getAnnotatedTypeMirror(Element e)

Returns the annotated type for e containing only annotations explicitly written in a stub file or null if e does not appear in a stub file.

Parameters:

e - an Element whose type is returned

Returns:

an AnnotatedTypeMirror for e containing only annotations explicitly written in the stubfile and in the element. null is returned if element does not appear in a stub file.

getDeclAnnotation

public Set<AnnotationMirror> getDeclAnnotation(Element elt)

Returns the set of declaration annotations for e containing only annotations explicitly written in a stub file or the empty set if e does not appear in a stub file.

Parameters:

elt - element for which annotations are returned

Returns:

an AnnotatedTypeMirror for e containing only annotations explicitly written in the stubfile and in the element. null is returned if element does not appear in a stub file.