Refactor cache to determine if an element is annotatedfor

[aosen-xiong]

In this PR, I refactored the isElementAnnotatedForThisChecker and its cache from QualifierDefaults to AnnotatedTypeFactory to foster code reuse in both determining the default and whether error should be suppressed. I am making the method SourceChecker#isElementAnnotatedForThisChecker abstract to reduce code duplication.

[wmdietl]

Thanks!

[aosen-xiong]

This call is causing the problem :-1: warning: junit-assertions.astub: Parse problem: org.checkerframework.javacutil.TypeSystemError: Called getTypeFactory() before initialization was complet.

It is interesting I can not get the type factory from the checker itself because the visitor is not initialized, even though I already had atypeFactory.

[aosen-xiong]

According to stacktrace, the method call went wrong because the chain initialization is init_checker -> init_visitor -> init_atf -> postinit in atf's constructor -> parsestubfiles -> determine default -> atf.getchecker().getTypeFactory(). We can get the checker from the atf successfully because it is assigned in the AnnotatedTypeFactory's constructor. But we don't have the visitor yet from the checker because it is the one underinitialization. Looks like this error too conservative because a partially initialized atf is able to determine whether an element is annotated or not.

at org.checkerframework.framework.stub.AnnotationFileElementTypes.parseStubFiles(AnnotationFileElementTypes.java:210)
at org.checkerframework.framework.type.AnnotatedTypeFactory.parseAnnotationFiles(AnnotatedTypeFactory.java:4097)
at org.checkerframework.framework.type.GenericAnnotatedTypeFactory.postInit(GenericAnnotatedTypeFactory.java:438)
at org.checkerframework.checker.initialization.InitializationAnnotatedTypeFactory.<init>(InitializationAnnotatedTypeFactory.java:60)
at org.checkerframework.checker.initialization.InitializationVisitor.createTypeFactory(InitializationVisitor.java:84)
at org.checkerframework.checker.initialization.InitializationVisitor.createTypeFactory(InitializationVisitor.java:52)
at org.checkerframework.common.basetype.BaseTypeVisitor.<init>(BaseTypeVisitor.java:343)
at org.checkerframework.common.basetype.BaseTypeVisitor.<init>(BaseTypeVisitor.java:329)
at org.checkerframework.checker.initialization.InitializationVisitor.<init>(InitializationVisitor.java:77)
at org.checkerframework.checker.initialization.InitializationChecker.createSourceVisitor(InitializationChecker.java:149)
at org.checkerframework.checker.initialization.InitializationChecker.createSourceVisitor(InitializationChecker.java:73)
at org.checkerframework.framework.source.SourceChecker.initChecker(SourceChecker.java:1175)

[aosen-xiong]

Previous version works with code duplication because works flow is init_checker -> init_visitor -> init_atf -> postinit in atf's constructor -> parsestubfiles -> determine default -> atf. I am going to revert to previous version with some comments.

[Copilot]

Pull request overview

This PR refactors the cache and method for determining if an element is annotated for a checker, moving it from QualifierDefaults to AnnotatedTypeFactory to enable code reuse. The method isElementAnnotatedForThisChecker is renamed to isElementAnnotatedForThisCheckerOrUpstreamChecker and made abstract in SourceChecker.

• Moved the isElementAnnotatedForThisChecker method and its cache from QualifierDefaults to AnnotatedTypeFactory
• Made SourceChecker#isElementAnnotatedForThisCheckerOrUpstreamChecker an abstract method
• Implemented the abstract method in all subclasses (BaseTypeChecker, AggregateChecker, and utility checkers)

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
QualifierDefaults.java	Removed private isElementAnnotatedForThisChecker method and elementAnnotatedFors cache; updated calls to use the factory method
AnnotatedTypeFactory.java	Added public isElementAnnotatedForThisCheckerOrUpstreamChecker method with the cache implementation
SourceChecker.java	Changed method from private to protected abstract; removed implementation and imports; updated method calls
BaseTypeChecker.java	Implemented abstract method by delegating to the type factory
AggregateChecker.java	Implemented abstract method to return false (delegates to subcheckers)
SignaturePrinter.java	Implemented abstract method to throw BugInCF (not expected to be called)
JavaCodeStatistics.java	Implemented abstract method to throw BugInCF (not expected to be called)
AnnotationStatistics.java	Implemented abstract method to throw BugInCF (not expected to be called)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[wmdietl]

@aosen-xiong Please go through the copilot suggestions and see what should be addressed.

[aosen-xiong]

Weird, CI failed again.

[aosen-xiong]

@wmdietl ping for review.

[aosen-xiong]

@wmdietl Hi Werner, can you please review this PR? Thanks. After this one, we can move to #1304.

[aosen-xiong]

@thisisalexandercook Hi Alex, can you also review this PR? Thanks!