Package org.checkerframework.common.util.count.report

Class ReportChecker

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.checkerframework.javacutil.AbstractTypeProcessor

org.checkerframework.framework.source.SourceChecker

org.checkerframework.common.basetype.BaseTypeChecker

org.checkerframework.common.util.count.report.ReportChecker

All Implemented Interfaces:

Processor, OptionConfiguration

@SupportedOptions({"reportTreeKinds","reportModifiers"})
public class ReportChecker
extends BaseTypeChecker

The Report Checker performs semantic searches over a program, for example, to find all methods that override a specific method, all classes that inherit from a specific class, or all uses of do-while loops (and not also while loops!).

The search is specified in two different ways.

The first way is to write a stub specification file using the annotations in org.checkerframework.common.util.count.report.qual.*. You can see examples in the Checker Framework repository at framework/tests/report/reporttest.astub and framework/jtreg/StubParserEnum/AnnotationFileParserEnum.astub.

The second way is the -AreportTreeKinds and -AreportModifiers options, which search for specific tree kinds or modifiers.

Some similar features are available from IDEs (e.g., show references), but this tool provides much more flexibility and a command-line tool.

Options:

• -AreportTreeKinds: comma-separated list of Tree.Kinds that should be reported
• -AreportModifiers: comma-separated list of modifiers that should be reported

See Also:

• AnnotationStatistics
• JavaCodeStatistics

Field Summary

Fields inherited from class org.checkerframework.framework.source.SourceChecker

currentRoot, DETAILS_SEPARATOR, elements, elementsWithSuppressedWarnings, errsOnLastExit, javacErrored, messager, messagesProperties, MSGS_FILE, OPTION_SEPARATOR, parentChecker, SUPPRESS_ALL_MESSAGE_KEY, SUPPRESS_ALL_PREFIX, trees, types, UNNEEDED_SUPPRESSION_KEY, upstreamCheckerNames, useAllcheckersPrefix, visitor

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
ReportChecker()	Creates a ReportChecker.

Method Summary

Methods inherited from class org.checkerframework.common.basetype.BaseTypeChecker

createSourceVisitor, createSourceVisitorPublic, getAnnotationProvider, getExtraStubFiles, getImmediateSubcheckerClasses, getOptions, getOptionsNoSubcheckers, getRelatedClassName, getSubchecker, getSubcheckers, getSupportedLintOptions, getSupportedOptions, getSuppressWarningsPrefixesOfSubcheckers, getTreePathCacher, getTypeFactory, getTypeFactoryOfSubcheckerOrNull, getUltimateParentChecker, getVisitor, hasOptionNoSubcheckers, initChecker, invokeConstructorFor, printOrStoreMessage, processErrorMessageArg, setRoot, shouldAddShutdownHook, shouldResolveReflection, shutdownHook, typeProcess, typeProcessingOver, warnUnneededSuppressions

Methods inherited from class org.checkerframework.framework.source.SourceChecker

addOptions, createSupportedLintOptions, expandCFOptions, fullMessageOf, getBooleanOption, getBooleanOption, getElementUtils, getLintOption, getLintOption, getMessagesProperties, getOption, getOption, getOptionConfiguration, getParentChecker, getPathToCompilationUnit, getProcessingEnvironment, getProperties, getStandardSuppressWarningsPrefixes, getStringsOption, getStringsOption, getSupportedAnnotationTypes, getSupportedSourceVersion, getSuppressWarningsPrefixes, getTreeUtils, getTypeUtils, getUpstreamCheckerNames, hasOption, init, message, message, messageKeyMatches, printOrStoreMessage, printStats, report, reportError, reportWarning, setLintOption, setParentChecker, setProcessingEnvironment, setSupportedLintOptions, shouldSkipDefs, shouldSkipDefs, shouldSkipDefs, shouldSkipFiles, shouldSkipUses, shouldSkipUses, shouldSuppressWarnings, shouldSuppressWarnings, shouldSuppressWarnings, typeProcessingStart, useConservativeDefault, warnUnneededSuppressions

Methods inherited from class org.checkerframework.javacutil.AbstractTypeProcessor

getCompilerLog, process

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.checkerframework.framework.util.OptionConfiguration

getStringsOption, getStringsOption

Constructor Details

ReportChecker

public ReportChecker()

Creates a ReportChecker.