edu.umd.cs.findbugs
public interface BugCollection
Field Summary | |
---|---|
static String | ANALYSIS_ERROR_ELEMENT_NAME |
static String | APP_CLASS_ELEMENT_NAME |
static String | CLASS_HASHES_ELEMENT_NAME |
static String | ERRORS_ELEMENT_NAME |
static String | ERROR_ELEMENT_NAME |
static String | ERROR_EXCEPTION_ELEMENT_NAME |
static String | ERROR_MESSAGE_ELEMENT_NAME |
static String | ERROR_STACK_TRACE_ELEMENT_NAME |
static String | HISTORY_ELEMENT_NAME |
static String | MISSING_CLASS_ELEMENT_NAME |
static String | PROJECT_ELEMENT_NAME |
static String | ROOT_ELEMENT_NAME |
static String | SRCMAP_ELEMENT_NAME |
static String | SUMMARY_HTML_ELEMENT_NAME |
Method Summary | |
---|---|
boolean | add(BugInstance bugInstance)
Add a BugInstance to this BugCollection.
|
boolean | add(BugInstance bugInstance, boolean updateActiveTime)
Add a BugInstance to this BugCollection.
|
void | addAppVersion(AppVersion appVersion)
Add an AppVersion representing a version of the analyzed application.
|
void | addError(String message)
Add an analysis error.
|
void | addError(AnalysisError error)
Add an analysis error.
|
void | addMissingClass(String message)
Add a missing class message.
|
Iterator<AppVersion> | appVersionIterator()
Get an Iterator over AppVersions defined in the collection. |
abstract void | clearAppVersions()
Clear all AppVersions representing previously-analyzed versions
of the application. |
void | clearClassFeatures() |
BugCollection | createEmptyCollectionWithMetadata()
Create a new empty BugCollection with the same metadata as this one.
|
BugInstance | findBug(String instanceHash, String bugType, int lineNumber) |
long | getAnalysisTimestamp()
Get the timestamp for when the analysis was performed. |
AppVersion | getAppVersionFromSequenceNumber(long target)
Gets the AppVersion corresponding to the given sequence number. |
Collection<BugInstance> | getCollection()
Return the Collection storing the BugInstance objects. |
AppVersion | getCurrentAppVersion()
Get the current AppVersion. |
ProjectStats | getProjectStats()
Get the project stats. |
String | getReleaseName()
Get the current release name.
|
long | getSequenceNumber()
Get the sequence number of the BugCollection.
|
long | getTimestamp()
Get the timestamp for the analyzed code
return the timestamp. |
boolean | getWithMessages()
Return whether textual messages will be added to any generated XML |
Iterator<BugInstance> | iterator()
Return an Iterator over all the BugInstance objects in
the BugCollection. |
BugInstance | lookupFromUniqueId(String uniqueId)
Look up a BugInstance by its unique id.
|
void | readXML(String fileName, Project project)
Read XML data from given file into this object,
populating given Project as a side effect.
|
void | readXML(InputStream in, Project project)
Read XML data from given input stream into this
object, populating the Project as a side effect.
|
void | setAnalysisTimestamp(long timestamp)
Get the timestamp for when the analysis was performed.
|
void | setClassFeatureSet(ClassFeatureSet classFeatureSet) |
void | setReleaseName(String releaseName)
Set the current release name.
|
void | setSequenceNumber(long sequence)
Set the sequence number of the BugCollection.
|
void | setTimestamp(long timestamp)
Get the timestamp for the analyzed code
|
void | setWithMessages(boolean withMessages)
Set whether textual messages should be added to any generated XML |
Document | toDocument(Project project)
Convert the BugCollection into a dom4j Document object.
|
void | writeEpilogue(XMLOutput xmlOutput) |
void | writePrologue(XMLOutput xmlOutput, Project project) |
void | writeXML(String fileName, Project project)
Write this BugCollection to a file as XML.
|
void | writeXML(OutputStream out, Project project)
Write the BugCollection to given output stream as XML.
|
void | writeXML(XMLOutput xmlOutput, Project project)
Write the BugCollection to an XMLOutput object.
|
Parameters: bugInstance the BugInstance
Returns: true if the BugInstance was added, or false if a matching BugInstance was already in the BugCollection
Parameters: bugInstance the BugInstance updateActiveTime true if the warning's active time should be updated to include the collection's current time
Returns: true if the BugInstance was added, or false if a matching BugInstance was already in the BugCollection
Parameters: appVersion the AppVersion
Parameters: message the error message
Parameters: error the AnalysisError object to add
Parameters: message the missing class message
Returns: a new empty BugCollection with the same metadata as this one
Returns: current release name
Returns: the sequence number
Parameters: uniqueId the BugInstance's unique id.
Returns: the BugInstance with the given unique id, or null if there is no such BugInstance This is deprecated; uniqueIDs are not persistent.
Parameters: fileName name of the file to read project the Project
Parameters: in the InputStream project the Project
Parameters: timestamp the analysis timestamp.
Parameters: releaseName the current release name
Parameters: sequence the sequence number
See Also: getSequenceNumber
Parameters: timestamp the timestamp.
Parameters: project the Project from which the BugCollection was generated
Returns: the Document representing the BugCollection as a dom4j tree
Parameters: fileName the file to write to project the Project from which the BugCollection was generated
Parameters: out the OutputStream to write to project the Project from which the BugCollection was generated
To write the SummaryHTML element, set property findbugs.report.SummaryHTML to "true".
Parameters: xmlOutput the XMLOutput object project the Project from which the BugCollection was generated