edu.umd.cs.findbugs.jaif

Interface JAIFEvents

public interface JAIFEvents

Callbacks for parsing an extenal annotation file.

Author:

David Hovemeyer

See Also:

Annotation File Utilities/

Method Summary

Methods

Modifier and Type	Method and Description
void	annotationField(String fieldName, Object constant) Called to visit an annotation field.
void	annotationFieldDefinition(String type, String fieldName) Called to visit an annotation field definition.
void	endAnnotation(String annotationName) Called to indicate the end of an annotation.
void	endAnnotationDefinition(String annotationName) Called to indicate the end of an annotation definition.
void	endPackageDefinition(String pkgName) Called to indicate the end of a package definition.
void	startAnnotation(String annotationName) Called to indicate the start of an annotation.
void	startAnnotationDefinition(String annotationName, String retention) Called to indicate the start of an annotation definition.
void	startPackageDefinition(String pkgName) Called to indicate the start of a package definition.

Method Detail

startPackageDefinition

void startPackageDefinition(String pkgName)

Called to indicate the start of a package definition.

Parameters:

pkgName - package name

endPackageDefinition

void endPackageDefinition(String pkgName)

Called to indicate the end of a package definition.

Parameters:

pkgName -

startAnnotation

void startAnnotation(String annotationName)

Called to indicate the start of an annotation.

Parameters:

annotationName - annotation name

endAnnotation

void endAnnotation(String annotationName)

Called to indicate the end of an annotation.

Parameters:

annotationName - annotation name

annotationField

void annotationField(String fieldName,
                   Object constant)

Called to visit an annotation field.

Parameters:

fieldName - annotation field name

constant - constant value of the annotation field (one of the java.lang wrapper types, or a String, or ???)

startAnnotationDefinition

void startAnnotationDefinition(String annotationName,
                             String retention)

Called to indicate the start of an annotation definition.

Parameters:

annotationName - name of the annotation

retention - retention: one of "visible", "invisible", or "source"

endAnnotationDefinition

void endAnnotationDefinition(String annotationName)

Called to indicate the end of an annotation definition.

Parameters:

annotationName - name of the annotation

annotationFieldDefinition

void annotationFieldDefinition(String type,
                             String fieldName)

Called to visit an annotation field definition.

Parameters:

type - type of the annotation field (in JVM signature format)

fieldName - name of the annotation field