FindBugs™ 1.3.9

edu.umd.cs.findbugs
Class IntAnnotation

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

public class IntAnnotation
extends java.lang.Object
implements BugAnnotation

Bug annotation class for integer values.

Author:
David Hovemeyer
See Also:
BugAnnotation, Serialized Form

Field Summary
static java.lang.String INT_ACTUAL_ARGUMENTS
           
static java.lang.String INT_EXPECTED_ARGUMENTS
           
static java.lang.String INT_OBLIGATIONS_REMAINING
           
static java.lang.String INT_OCCURRENCES
           
static java.lang.String INT_SHIFT
           
static java.lang.String INT_SYNC_PERCENT
           
static java.lang.String INT_VALUE
           
 
Fields inherited from interface edu.umd.cs.findbugs.BugAnnotation
MESSAGE_TAG
 
Constructor Summary
IntAnnotation(int 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.
 java.lang.String getDescription()
          Get a description of this bug annotation.
 int getValue()
          Get the integer 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

INT_SYNC_PERCENT

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

INT_OCCURRENCES

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

INT_VALUE

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

INT_SHIFT

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

INT_EXPECTED_ARGUMENTS

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

INT_ACTUAL_ARGUMENTS

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

INT_OBLIGATIONS_REMAINING

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

IntAnnotation

public IntAnnotation(int value)
Constructor.

Parameters:
value - the integer value
Method Detail

clone

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

getValue

public int getValue()
Get the integer value.

Returns:
the integer 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.