|
|||||||||
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
Field Summary | |
---|---|
protected java.lang.String |
className
|
protected java.lang.String |
description
|
Constructor Summary | |
---|---|
PackageMemberAnnotation(java.lang.String className,
java.lang.String description)
Constructor. |
Method Summary | |
---|---|
java.lang.String |
format(java.lang.String key)
Format the annotation. |
protected abstract java.lang.String |
formatPackageMember(java.lang.String key)
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. |
void |
setDescription(java.lang.String description)
Set a description of this bug annotation. |
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 |
---|
clone, 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.xml.XMLWriteable |
---|
writeXML |
Field Detail |
---|
protected java.lang.String className
protected java.lang.String description
Constructor Detail |
---|
public PackageMemberAnnotation(java.lang.String className, java.lang.String description)
className
- name of the classMethod Detail |
---|
public final java.lang.String getClassName()
public final java.lang.String getPackageName()
public final java.lang.String format(java.lang.String key)
format
in interface BugAnnotation
key
- the key
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 abstract java.lang.String formatPackageMember(java.lang.String key)
key
- the key specifying how to do the formattingpublic java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |