edu.umd.cs.findbugs

Class BugProperty

java.lang.Object

edu.umd.cs.findbugs.BugProperty

All Implemented Interfaces:

XMLWriteable, java.io.Serializable, java.lang.Cloneable

public class BugProperty
extends java.lang.Object
implements XMLWriteable, java.io.Serializable, java.lang.Cloneable

Name/value metadata pair that may be attached to a BugInstance. These are different from BugAnnotations because they are not meant to be shown directly to the user.

Author:

David Hovemeyer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IS_BUG Boolean property defining whether or not the BugInstance is really a bug.
static java.lang.String	SEVERITY Integer property defining the warning severity (1=least severe, 5=most severe).

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.Object	clone()
java.lang.String	getName() Get name of property.
java.lang.String	getValue() Get value of property.
boolean	getValueAsBoolean() Get value of property as boolean.
int	getValueAsInt() Get value of property as an integer.
void	setValue(java.lang.String value) Set value of property.
void	writeXML(XMLOutput xmlOutput) Write this object to given XMLOutput.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IS_BUG

public static final java.lang.String IS_BUG

Boolean property defining whether or not the BugInstance is really a bug.

See Also:

Constant Field Values

SEVERITY

public static final java.lang.String SEVERITY

Integer property defining the warning severity (1=least severe, 5=most severe).

See Also:

Constant Field Values

Method Detail

clone

protected java.lang.Object clone()

Overrides:

clone in class java.lang.Object

getName

public java.lang.String getName()

Get name of property.

Returns:

name of property

getValue

public java.lang.String getValue()

Get value of property.

Returns:

value of property

getValueAsBoolean

public boolean getValueAsBoolean()

Get value of property as boolean.

Returns:

value of property as a boolean

getValueAsInt

public int getValueAsInt()

Get value of property as an integer.

Returns:

value of property as integer

Throws:

java.lang.NumberFormatException - if the value cannot be parsed as an integer

setValue

public void setValue(java.lang.String value)

Set value of property.

Parameters:

value -

writeXML

public void writeXML(XMLOutput xmlOutput)
              throws java.io.IOException

Description copied from interface: XMLWriteable

Write this object to given XMLOutput.

Specified by:

writeXML in interface XMLWriteable

Parameters:

xmlOutput - the XMLOutput for the document

Throws:

java.io.IOException