FindBugs™ 1.3.8

edu.umd.cs.findbugs.userAnnotations.ri
Class XMLFileUserAnnotationPlugin

java.lang.Object
  extended by edu.umd.cs.findbugs.userAnnotations.ri.XMLFileUserAnnotationPlugin
All Implemented Interfaces:
UserAnnotationPlugin

public class XMLFileUserAnnotationPlugin
extends java.lang.Object
implements UserAnnotationPlugin

Reference implementation of user annotation plugin. Persists user annotations using instance hash as a key, storing the user annotations in an XML file. This plugin is mostly a proof of concept, although it might be more generally useful.

Author:
David Hovemeyer

Field Summary
static boolean DEBUG
           
 
Constructor Summary
XMLFileUserAnnotationPlugin()
           
 
Method Summary
 java.util.Set<java.lang.String> getPropertyNames()
           
 void loadUserAnnotations(BugCollection bugs)
          For the given BugCollection, load the user annotations for each BugInstance in the collection.
 boolean setProperties(java.util.Map<java.lang.String,java.lang.String> properties)
           
 void storeUserAnnotation(BugInstance bug)
          Store the user annotation for the given BugInstance.
 void storeUserAnnotations(BugCollection bugs)
          Store the user annotation for all BugInstances in the given BugCollection.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEBUG

public static final boolean DEBUG
Constructor Detail

XMLFileUserAnnotationPlugin

public XMLFileUserAnnotationPlugin()
Method Detail

getPropertyNames

public java.util.Set<java.lang.String> getPropertyNames()

setProperties

public boolean setProperties(java.util.Map<java.lang.String,java.lang.String> properties)

loadUserAnnotations

public void loadUserAnnotations(BugCollection bugs)
Description copied from interface: UserAnnotationPlugin
For the given BugCollection, load the user annotations for each BugInstance in the collection.

Specified by:
loadUserAnnotations in interface UserAnnotationPlugin
Parameters:
bugs - a BugCollection

storeUserAnnotation

public void storeUserAnnotation(BugInstance bug)
Description copied from interface: UserAnnotationPlugin
Store the user annotation for the given BugInstance.

Specified by:
storeUserAnnotation in interface UserAnnotationPlugin
Parameters:
bug - a BugInstance

storeUserAnnotations

public void storeUserAnnotations(BugCollection bugs)
Description copied from interface: UserAnnotationPlugin
Store the user annotation for all BugInstances in the given BugCollection.

Specified by:
storeUserAnnotations in interface UserAnnotationPlugin
Parameters:
bugs - a BugCollection

FindBugs™ 1.3.8

FindBugs™ is licenced under the LGPL. Copyright © 2006 University of Maryland.