public class StringAnnotation extends java.lang.Object implements BugAnnotation
BugAnnotation
,
Serialized FormModifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_ROLE |
static java.lang.String |
ERROR_MSG_ROLE |
static java.lang.String |
FORMAT_SPECIFIER_ROLE |
static java.lang.String |
FORMAT_STRING_ROLE |
static java.lang.String |
PARAMETER_NAME_ROLE |
static java.lang.String |
REGEX_ROLE |
static java.lang.String |
REMAINING_OBLIGATIONS_ROLE |
static java.lang.String |
STRING_CONSTANT_ROLE |
static java.lang.String |
STRING_MESSAGE |
static java.lang.String |
STRING_NONSTRING_CONSTANT_ROLE
Used for non-string constants (e.g., null)
|
static java.lang.String |
TYPE_QUALIFIER_ROLE |
MESSAGE_TAG
Constructor and Description |
---|
StringAnnotation(java.lang.String value)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
accept(BugAnnotationVisitor visitor)
Accept a BugAnnotationVisitor.
|
java.lang.Object |
clone() |
int |
compareTo(BugAnnotation o) |
boolean |
equals(java.lang.Object o) |
java.lang.String |
format(java.lang.String key,
ClassAnnotation primaryClass)
Format the annotation as a String.
|
static StringAnnotation |
fromRawString(java.lang.String value) |
static StringAnnotation |
fromXMLEscapedString(java.lang.String value) |
java.lang.String |
getDescription()
Get a description of this bug annotation.
|
java.lang.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(java.lang.String description)
Set a description of this bug annotation.
|
java.lang.String |
toString() |
java.lang.String |
toString(ClassAnnotation primaryClass) |
void |
writeXML(XMLOutput xmlOutput)
Write this object to given XMLOutput.
|
void |
writeXML(XMLOutput xmlOutput,
boolean addMessages,
boolean isPrimary) |
public static final java.lang.String DEFAULT_ROLE
public static final java.lang.String STRING_CONSTANT_ROLE
public static final java.lang.String STRING_NONSTRING_CONSTANT_ROLE
public static final java.lang.String REGEX_ROLE
public static final java.lang.String ERROR_MSG_ROLE
public static final java.lang.String STRING_MESSAGE
public static final java.lang.String PARAMETER_NAME_ROLE
public static final java.lang.String TYPE_QUALIFIER_ROLE
public static final java.lang.String REMAINING_OBLIGATIONS_ROLE
public static final java.lang.String FORMAT_STRING_ROLE
public static final java.lang.String FORMAT_SPECIFIER_ROLE
public StringAnnotation(java.lang.String value)
value
- the String valuepublic static StringAnnotation fromRawString(java.lang.String value)
public static StringAnnotation fromXMLEscapedString(java.lang.String value)
public java.lang.Object clone()
clone
in interface BugAnnotation
clone
in class java.lang.Object
public java.lang.String getValue()
public void accept(BugAnnotationVisitor visitor)
BugAnnotation
accept
in interface BugAnnotation
visitor
- the visitor to acceptpublic java.lang.String format(java.lang.String key, ClassAnnotation primaryClass)
BugAnnotation
format
in interface BugAnnotation
key
- how the annotation should be formattedprimaryClass
- The primary class for the bug; some bug annotation format msgs
are simplified in relation to that class.public void setDescription(java.lang.String description)
BugAnnotation
setDescription
in interface BugAnnotation
public java.lang.String getDescription()
BugAnnotation
getDescription
in interface BugAnnotation
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int compareTo(BugAnnotation o)
compareTo
in interface java.lang.Comparable<BugAnnotation>
public java.lang.String toString()
toString
in class java.lang.Object
public void writeXML(XMLOutput xmlOutput) throws java.io.IOException
XMLWriteable
writeXML
in interface XMLWriteable
xmlOutput
- the XMLOutput for the documentjava.io.IOException
public void writeXML(XMLOutput xmlOutput, boolean addMessages, boolean isPrimary) throws java.io.IOException
writeXML
in interface XMLWriteableWithMessages
java.io.IOException
public boolean isSignificant()
BugAnnotation
isSignificant
in interface BugAnnotation
public java.lang.String toString(ClassAnnotation primaryClass)
toString
in interface BugAnnotation
FindBugs™ is licenced under the LGPL. Copyright © 2006 University of Maryland.