Package 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

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

    • Method Detail

      • startPackageDefinition

        void startPackageDefinition​(java.lang.String pkgName)
        Called to indicate the start of a package definition.
        Parameters:
        pkgName - package name

      • endPackageDefinition

        void endPackageDefinition​(java.lang.String pkgName)
        Called to indicate the end of a package definition.
        Parameters:
        pkgName -

      • startAnnotation

        void startAnnotation​(java.lang.String annotationName)
        Called to indicate the start of an annotation.
        Parameters:
        annotationName - annotation name

      • endAnnotation

        void endAnnotation​(java.lang.String annotationName)
        Called to indicate the end of an annotation.
        Parameters:
        annotationName - annotation name

      • annotationField

        void annotationField​(java.lang.String fieldName,
                     java.lang.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​(java.lang.String annotationName,
                               java.lang.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​(java.lang.String annotationName)
        Called to indicate the end of an annotation definition.
        Parameters:
        annotationName - name of the annotation

      • annotationFieldDefinition

        void annotationFieldDefinition​(java.lang.String type,
                               java.lang.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