edu.umd.cs.findbugs

Class BugDesignation

public class BugDesignation extends Object implements XMLWriteable, Serializable

class to hold the user annotation and user designation for a BugInstance
Field Summary
static StringUNCLASSIFIED
The default key for the user designation.
Method Summary
longgetTimestamp()
voidmerge(BugDesignation other)
replace unset fields of this user designation with values set in the other
voidsetAnnotationText(String s)
voidsetDesignationKey(String designationKey)
set the user designation E.g., "MOSTLY_HARMLESS", "CRITICAL", "NOT_A_BUG", etc.
voidsetTimestamp(long ts)
voidsetUser(String u)
voidwriteXML(XMLOutput xmlOutput)

Field Detail

UNCLASSIFIED

public static final String UNCLASSIFIED
The default key for the user designation. Bad things could happen if this key isn't in getUserDesignations()

Method Detail

getTimestamp

public long getTimestamp()

merge

public void merge(BugDesignation other)
replace unset fields of this user designation with values set in the other

setAnnotationText

public void setAnnotationText(String s)

setDesignationKey

public void setDesignationKey(String designationKey)
set the user designation E.g., "MOSTLY_HARMLESS", "CRITICAL", "NOT_A_BUG", etc. If the argument is null, it will be treated as UNCLASSIFIED. Note that this is the key, suitable for writing to XML, but not what the user sees. Strange things could happen if designationKey is not one of the keys returned by I18N.instance().getUserDesignations().

See Also: getUserDesignationKeys

setTimestamp

public void setTimestamp(long ts)

setUser

public void setUser(String u)

writeXML

public void writeXML(XMLOutput xmlOutput)
FindBugs™ is licenced under the LGPL. Copyright © 2006 University of Maryland.