Package org.checkerframework.common.util.debug

Class SignaturePrinter

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.checkerframework.javacutil.AbstractTypeProcessor

org.checkerframework.common.util.debug.SignaturePrinter

All Implemented Interfaces:

Processor

@SupportedSourceVersion(RELEASE_8)
@SupportedAnnotationTypes("*")
@SupportedOptions("checker")
public class SignaturePrinter
extends AbstractTypeProcessor

Outputs the method signatures of a class with fully annotated types.

The class determines the effective annotations for a checker in source or the classfile. Finding the effective annotations is useful for the following purposes:

1. Debugging annotations in classfile
2. Debugging the default annotations that are implicitly added by the checker

The class can be used in two possible ways, depending on the type file:

1. From source: the class is to be used as an annotation processor when reading annotations from source. It can be invoked via the command:

   javac -processor SignaturePrinter <java files> ...

2. From classfile: the class is to be used as an independent app when reading annotations from classfile. It can be invoked via the command:

   java SignaturePrinter <class name>

By default, only the annotations explicitly written by the user are emitted. To view the default and effective annotations in a class that are associated with a checker, the fully qualified name of the checker needs to be passed as -Achecker= argument, e.g.

 javac -processor SignaturePrinter
       -Achecker=org.checkerframework.checker.nullness.NullnessChecker JavaFile.java
 

Field Summary

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
SignaturePrinter()	Creates a SignaturePrinter.

Method Summary

Modifier and Type	Method	Description
static void	main(String[] args)
static void	printUsage()
void	typeProcess(TypeElement element, TreePath p)	Processes a fully-analyzed class that contains a supported annotation (see AbstractProcessor.getSupportedAnnotationTypes()).
void	typeProcessingStart()	A method to be called once before the first call to typeProcess.

Methods inherited from class org.checkerframework.javacutil.AbstractTypeProcessor

getCompilerLog, init, process, typeProcessingOver

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, isInitialized

Methods inherited from class java.lang.Object

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

Constructor Details

SignaturePrinter

public SignaturePrinter()

Creates a SignaturePrinter.

Method Details

typeProcessingStart

public void typeProcessingStart()

Description copied from class: AbstractTypeProcessor

A method to be called once before the first call to typeProcess.

Subclasses may override this method to do any initialization work.

Overrides:

typeProcessingStart in class AbstractTypeProcessor

typeProcess

public void typeProcess(TypeElement element,
 TreePath p)

Description copied from class: AbstractTypeProcessor

Processes a fully-analyzed class that contains a supported annotation (see AbstractProcessor.getSupportedAnnotationTypes()).

The passed class is always valid type-checked Java code.

Specified by:

typeProcess in class AbstractTypeProcessor

Parameters:

element - element of the analyzed class

p - the tree path to the element, with the leaf being a ClassTree

printUsage

public static void printUsage()

main

public static void main(String[] args)