Package edu.umd.cs.findbugs

Class StringAnnotation

java.lang.Object

edu.umd.cs.findbugs.StringAnnotation

All Implemented Interfaces:

BugAnnotation, XMLWriteable, XMLWriteableWithMessages, Serializable, Cloneable, Comparable<BugAnnotation>

public class StringAnnotation
extends Object
implements BugAnnotation

Bug annotation class for string values.

Author:

William Pugh

See Also:

• BugAnnotation
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ROLE
static final String	ERROR_MSG_ROLE
static final String	FORMAT_SPECIFIER_ROLE
static final String	FORMAT_STRING_ROLE
static final String	PARAMETER_NAME_ROLE
static final String	REGEX_ROLE
static final String	REMAINING_OBLIGATIONS_ROLE
static final String	STRING_CONSTANT_ROLE
static final String	STRING_MESSAGE
static final String	STRING_NONSTRING_CONSTANT_ROLE	Used for non-string constants (e.g., null)
static final String	TYPE_QUALIFIER_ROLE

Fields inherited from interface edu.umd.cs.findbugs.BugAnnotation

MESSAGE_TAG

Constructor Summary

Constructors

Constructor	Description
StringAnnotation(String value)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	accept(BugAnnotationVisitor visitor)	Accept a BugAnnotationVisitor.
Object	clone()
int	compareTo(BugAnnotation o)
boolean	equals(Object o)
String	format(String key, ClassAnnotation primaryClass)	Format the annotation as a String.
static StringAnnotation	fromRawString(String value)
static StringAnnotation	fromXMLEscapedString(String value)
String	getDescription()	Get a description of this bug annotation.
String	getValue()	Get the String value.
int	hashCode()
boolean	isSignificant()	Is this annotation used to compute instance hashes or match bug instances across versions
void	setDescription(String description)	Set a description of this bug annotation.
String	toString()
String	toString(ClassAnnotation primaryClass)
void	writeXML(XMLOutput xmlOutput)	Write this object to given XMLOutput.
void	writeXML(XMLOutput xmlOutput, boolean addMessages, boolean isPrimary)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_ROLE

public static final String DEFAULT_ROLE

See Also:

• Constant Field Values

STRING_CONSTANT_ROLE

public static final String STRING_CONSTANT_ROLE

See Also:

• Constant Field Values

STRING_NONSTRING_CONSTANT_ROLE

public static final String STRING_NONSTRING_CONSTANT_ROLE

Used for non-string constants (e.g., null)

See Also:

• Constant Field Values

REGEX_ROLE

public static final String REGEX_ROLE

See Also:

• Constant Field Values

ERROR_MSG_ROLE

public static final String ERROR_MSG_ROLE

See Also:

• Constant Field Values

STRING_MESSAGE

public static final String STRING_MESSAGE

See Also:

• Constant Field Values

PARAMETER_NAME_ROLE

public static final String PARAMETER_NAME_ROLE

See Also:

• Constant Field Values

TYPE_QUALIFIER_ROLE

public static final String TYPE_QUALIFIER_ROLE

See Also:

• Constant Field Values

REMAINING_OBLIGATIONS_ROLE

public static final String REMAINING_OBLIGATIONS_ROLE

See Also:

• Constant Field Values

FORMAT_STRING_ROLE

public static final String FORMAT_STRING_ROLE

See Also:

• Constant Field Values

FORMAT_SPECIFIER_ROLE

public static final String FORMAT_SPECIFIER_ROLE

See Also:

• Constant Field Values

Constructor Details

StringAnnotation

public StringAnnotation(String value)

Constructor.

Parameters:

value - the String value

Method Details

fromRawString

public static StringAnnotation fromRawString(String value)

fromXMLEscapedString

public static StringAnnotation fromXMLEscapedString(String value)

clone

public Object clone()

Specified by:

clone in interface BugAnnotation

Overrides:

clone in class Object

getValue

public String getValue()

Get the String value.

Returns:

the String value

accept

public void accept(BugAnnotationVisitor visitor)

Description copied from interface: BugAnnotation

Accept a BugAnnotationVisitor.

Specified by:

accept in interface BugAnnotation

Parameters:

visitor - the visitor to accept

format

public String format(String key,
 ClassAnnotation primaryClass)

Description copied from interface: BugAnnotation

Format the annotation as a String. The given key specifies additional information about how the annotation should be formatted. If the key is empty, then the "default" format will be used.

Specified by:

format in interface BugAnnotation

Parameters:

key - how the annotation should be formatted

primaryClass - The primary class for the bug; some bug annotation format msgs are simplified in relation to that class.

setDescription

public void setDescription(String description)

Description copied from interface: BugAnnotation

Set a description of this bug annotation. The description is a key for the FindBugsAnnotationDescriptions resource bundle.

Specified by:

setDescription in interface BugAnnotation

getDescription

public String getDescription()

Description copied from interface: BugAnnotation

Get a description of this bug annotation. The description is a key for the FindBugsAnnotationDescriptions resource bundle.

Specified by:

getDescription in interface BugAnnotation

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

compareTo

public int compareTo(BugAnnotation o)

Specified by:

compareTo in interface Comparable<BugAnnotation>

toString

public String toString()

Overrides:

toString in class Object

writeXML

public void writeXML(XMLOutput xmlOutput)
              throws 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:

IOException

writeXML

public void writeXML(XMLOutput xmlOutput,
 boolean addMessages,
 boolean isPrimary)
              throws IOException

Specified by:

writeXML in interface XMLWriteableWithMessages

Throws:

IOException

isSignificant

public boolean isSignificant()

Description copied from interface: BugAnnotation

Is this annotation used to compute instance hashes or match bug instances across versions

Specified by:

isSignificant in interface BugAnnotation

Returns:

true if significant

toString

public String toString(ClassAnnotation primaryClass)

Specified by:

toString in interface BugAnnotation