|
FindBugs™ 1.3.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.umd.cs.findbugs.PackageMemberAnnotation
public abstract class PackageMemberAnnotation
Abstract base class for BugAnnotations describing constructs which are contained in a Java package. Specifically, this includes classes, methods, and fields.
BugAnnotation
,
Serialized FormField Summary | |
---|---|
protected java.lang.String |
className
|
protected java.lang.String |
description
|
protected java.lang.String |
sourceFileName
|
protected SourceLineAnnotation |
sourceLines
|
Fields inherited from interface edu.umd.cs.findbugs.BugAnnotation |
---|
MESSAGE_TAG |
Constructor Summary | |
---|---|
protected |
PackageMemberAnnotation(java.lang.String className,
java.lang.String description)
Constructor. |
Method Summary | |
---|---|
java.lang.Object |
clone()
|
java.lang.String |
format(java.lang.String key,
ClassAnnotation primaryClass)
Format the annotation. |
protected abstract java.lang.String |
formatPackageMember(java.lang.String key,
ClassAnnotation primaryClass)
Do default and subclass-specific formatting. |
java.lang.String |
getClassName()
Get the class name. |
java.lang.String |
getDescription()
Get a description of this bug annotation. |
java.lang.String |
getPackageName()
Get the package name. |
java.lang.String |
getSourceFileName()
Get the source file name. |
SourceLineAnnotation |
getSourceLines()
Get the SourceLineAnnotation describing the source lines where the method is defined. |
boolean |
isSignificant()
Is this annotation used to compute instance hashes or match bug instances across versions |
protected static java.lang.String |
removePackageName(java.lang.String typeName)
Shorten a type name by removing the package name |
void |
setDescription(java.lang.String description)
Set a description of this bug annotation. |
void |
setSourceLines(SourceLineAnnotation sourceLines)
Set a SourceLineAnnotation describing the source lines where the package element is defined. |
protected static java.lang.String |
shorten(java.lang.String pkgName,
java.lang.String typeName)
Shorten a type name of remove extraneous components. |
java.lang.String |
toString()
All PackageMemberAnnotation object share a common toString() implementation. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface edu.umd.cs.findbugs.BugAnnotation |
---|
accept |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Methods inherited from interface edu.umd.cs.findbugs.XMLWriteableWithMessages |
---|
writeXML |
Methods inherited from interface edu.umd.cs.findbugs.xml.XMLWriteable |
---|
writeXML |
Field Detail |
---|
@DottedClassName protected final java.lang.String className
protected java.lang.String sourceFileName
protected java.lang.String description
protected SourceLineAnnotation sourceLines
Constructor Detail |
---|
protected PackageMemberAnnotation(@DottedClassName java.lang.String className, java.lang.String description)
className
- name of the classMethod Detail |
---|
public java.lang.Object clone()
clone
in interface BugAnnotation
clone
in class java.lang.Object
public final java.lang.String getSourceFileName()
@DottedClassName public final java.lang.String getClassName()
public final java.lang.String getPackageName()
public final java.lang.String format(java.lang.String key, ClassAnnotation primaryClass)
format
in interface BugAnnotation
key
- the keyprimaryClass
- TODO
public void setDescription(java.lang.String description)
BugAnnotation
setDescription
in interface BugAnnotation
public java.lang.String getDescription()
BugAnnotation
getDescription
in interface BugAnnotation
protected static java.lang.String shorten(java.lang.String pkgName, java.lang.String typeName)
java.lang
package.
protected static java.lang.String removePackageName(java.lang.String typeName)
protected abstract java.lang.String formatPackageMember(java.lang.String key, ClassAnnotation primaryClass)
key
- the key specifying how to do the formattingprimaryClass
- TODOpublic java.lang.String toString()
toString
in class java.lang.Object
public void setSourceLines(SourceLineAnnotation sourceLines)
public SourceLineAnnotation getSourceLines()
public boolean isSignificant()
BugAnnotation
isSignificant
in interface BugAnnotation
|
FindBugs™ 1.3.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |