FindBugs™ 1.3.9

edu.umd.cs.findbugs
Class StringAnnotation

java.lang.Object
  extended by edu.umd.cs.findbugs.StringAnnotation
All Implemented Interfaces:
BugAnnotation, XMLWriteable, XMLWriteableWithMessages, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<BugAnnotation>

public class StringAnnotation
extends java.lang.Object
implements BugAnnotation

Bug annotation class for string values.

Author:
William Pugh
See Also:
BugAnnotation, Serialized Form

Field Summary
static java.lang.String DEFAULT_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 REMAINING_OBLIGATIONS_ROLE
           
static java.lang.String STRING_CONSTANT_ROLE
           
static java.lang.String TYPE_QUALIFIER_ROLE
           
 
Fields inherited from interface edu.umd.cs.findbugs.BugAnnotation
MESSAGE_TAG
 
Constructor Summary
StringAnnotation(java.lang.String value)
          Constructor.
 
Method Summary
 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 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)
           
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_ROLE

public static final java.lang.String DEFAULT_ROLE
See Also:
Constant Field Values

STRING_CONSTANT_ROLE

public static final java.lang.String STRING_CONSTANT_ROLE
See Also:
Constant Field Values

PARAMETER_NAME_ROLE

public static final java.lang.String PARAMETER_NAME_ROLE
See Also:
Constant Field Values

TYPE_QUALIFIER_ROLE

public static final java.lang.String TYPE_QUALIFIER_ROLE
See Also:
Constant Field Values

REMAINING_OBLIGATIONS_ROLE

public static final java.lang.String REMAINING_OBLIGATIONS_ROLE
See Also:
Constant Field Values

FORMAT_STRING_ROLE

public static final java.lang.String FORMAT_STRING_ROLE
See Also:
Constant Field Values

FORMAT_SPECIFIER_ROLE

public static final java.lang.String FORMAT_SPECIFIER_ROLE
See Also:
Constant Field Values
Constructor Detail

StringAnnotation

public StringAnnotation(java.lang.String value)
Constructor.

Parameters:
value - the String value
Method Detail

fromXMLEscapedString

public static StringAnnotation fromXMLEscapedString(java.lang.String value)

clone

public java.lang.Object clone()
Specified by:
clone in interface BugAnnotation
Overrides:
clone in class java.lang.Object

getValue

public java.lang.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 java.lang.String format(java.lang.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(java.lang.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 java.lang.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 java.lang.Object

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

compareTo

public int compareTo(BugAnnotation o)
Specified by:
compareTo in interface java.lang.Comparable<BugAnnotation>

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

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

writeXML

public void writeXML(XMLOutput xmlOutput,
                     boolean addMessages,
                     boolean isPrimary)
              throws java.io.IOException
Specified by:
writeXML in interface XMLWriteableWithMessages
Throws:
java.io.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 java.lang.String toString(ClassAnnotation primaryClass)
Specified by:
toString in interface BugAnnotation

FindBugs™ 1.3.9

FindBugs™ is licenced under the LGPL. Copyright © 2006 University of Maryland.