Package org.checkerframework.common.reflection

Class ClassValChecker

  • All Implemented Interfaces:
    javax.annotation.processing.Processor, OptionConfiguration
    public class ClassValChecker
extends BaseTypeChecker
    The ClassVal Checker provides a sound estimate of the binary name of Class objects.
    See the Checker Framework Manual:
    ClassVal Checker

    • Constructor Detail

      • ClassValChecker

        public ClassValChecker()

    • Method Detail

      • createSourceVisitor

        protected BaseTypeVisitor<?> createSourceVisitor()
        Description copied from class: BaseTypeChecker
        Returns the appropriate visitor that type-checks the compilation unit according to the type system rules.

        This implementation uses the checker naming convention to create the appropriate visitor. If no visitor is found, it returns an instance of BaseTypeVisitor. It reflectively invokes the constructor that accepts this checker and the compilation unit tree (in that order) as arguments.

        Subclasses have to override this method to create the appropriate visitor if they do not follow the checker naming convention.

        Overrides:
        createSourceVisitor in class BaseTypeChecker
        Returns:
        the type-checking visitor

      • getImmediateSubcheckerClasses

        protected java.util.Set<java.lang.Class<? extends BaseTypeChecker>> getImmediateSubcheckerClasses()
        Description copied from class: BaseTypeChecker
        Returns the set of subchecker classes on which this checker depends. Returns an empty set if this checker does not depend on any others.

        Subclasses should override this method to specify subcheckers. If they do so, they should call the super implementation of this method and add dependencies to the returned set so that checkers required for reflection resolution are included if reflection resolution is requested.

        Each subchecker of this checker may also depend on other checkers. If this checker and one of its subcheckers both depend on a third checker, that checker will only be instantiated once.

        Though each checker is run on a whole compilation unit before the next checker is run, error and warning messages are collected and sorted based on the location in the source file before being printed. (See BaseTypeChecker.printOrStoreMessage(Diagnostic.Kind, String, Tree, CompilationUnitTree).)

        WARNING: Circular dependencies are not supported nor do checkers verify that their dependencies are not circular. Make sure no circular dependencies are created when overriding this method. (In other words, if checker A depends on checker B, checker B cannot depend on checker A.)

        This method is protected so it can be overridden, but it should only be called internally by the BaseTypeChecker.

        The BaseTypeChecker will not modify the set returned by this method, but clients that override the method do modify the set.

        Overrides:
        getImmediateSubcheckerClasses in class BaseTypeChecker
        Returns:
        the subchecker classes on which this checker depends; will be modified by callees in overriding methods

      • shouldResolveReflection

        public boolean shouldResolveReflection()
        Description copied from class: BaseTypeChecker
        Returns whether or not reflection should be resolved.
        Overrides:
        shouldResolveReflection in class BaseTypeChecker
        Returns:
        true if reflection should be resolved