Package org.checkerframework.common.util.count

Class JavaCodeStatistics

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.checkerframework.javacutil.AbstractTypeProcessor

org.checkerframework.framework.source.SourceChecker

org.checkerframework.common.util.count.JavaCodeStatistics

All Implemented Interfaces:

Processor, OptionConfiguration

@SupportedSourceVersion(RELEASE_8)
public class JavaCodeStatistics
extends SourceChecker

An annotation processor for counting a few specific aspects about the size of Java code:

• The number of type parameter declarations and uses.
• The number of array accesses and dimensions in array creations.
• The number of type casts.

To invoke it, use

 javac -proc:only -processor org.checkerframework.common.util.count.JavaCodeStatistics MyFile.java ...
 

See Also:

• AnnotationStatistics
• ReportChecker

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
JavaCodeStatistics()	Creates a JavaCodeStatistics.

Method Summary

Modifier and Type	Method	Description
protected SourceVisitor<?,?>	createSourceVisitor()	Provides the SourceVisitor that the checker should use to scan input source trees.
AnnotationProvider	getAnnotationProvider()	Returns the AnnotationProvider (the type factory) associated with this.
void	typeProcessingOver()	A method to be called once all the classes are processed.

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

addOptions, createSupportedLintOptions, expandCFOptions, fullMessageOf, getBooleanOption, getBooleanOption, getElementUtils, getLintOption, getLintOption, getMessagesProperties, getOption, getOption, getOptionConfiguration, getOptions, getParentChecker, getPathToCompilationUnit, getProcessingEnvironment, getProperties, getStandardSuppressWarningsPrefixes, getStringsOption, getStringsOption, getSupportedAnnotationTypes, getSupportedLintOptions, getSupportedOptions, getSupportedSourceVersion, getSuppressWarningsPrefixes, getTreeUtils, getTypeUtils, getUpstreamCheckerNames, getVisitor, hasOption, init, initChecker, message, message, messageKeyMatches, printOrStoreMessage, printOrStoreMessage, printStats, processErrorMessageArg, report, reportError, reportWarning, setLintOption, setParentChecker, setProcessingEnvironment, setRoot, setSupportedLintOptions, shouldAddShutdownHook, shouldSkipDefs, shouldSkipDefs, shouldSkipFiles, shouldSkipUses, shouldSkipUses, shouldSuppressWarnings, shouldSuppressWarnings, shouldSuppressWarnings, shutdownHook, typeProcess, typeProcessingStart, useConservativeDefault, warnUnneededSuppressions, 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

JavaCodeStatistics

public JavaCodeStatistics()

Creates a JavaCodeStatistics.

Method Details

typeProcessingOver

public void typeProcessingOver()

Description copied from class: AbstractTypeProcessor

A method to be called once all the classes are processed.

Subclasses may override this method to do any aggregate analysis (e.g. generate report, persistence) or resource deallocation.

Method AbstractTypeProcessor.getCompilerLog() can be used to access the number of compiler errors.

Overrides:

typeProcessingOver in class AbstractTypeProcessor

createSourceVisitor

protected SourceVisitor<?,?> createSourceVisitor()

Description copied from class: SourceChecker

Provides the SourceVisitor that the checker should use to scan input source trees.

Specified by:

createSourceVisitor in class SourceChecker

Returns:

a SourceVisitor to use to scan source trees

getAnnotationProvider

public AnnotationProvider getAnnotationProvider()

Description copied from class: SourceChecker

Returns the AnnotationProvider (the type factory) associated with this.

Overrides:

getAnnotationProvider in class SourceChecker

Returns:

the AnnotationProvider (the type factory) associated with this