Package edu.umd.cs.findbugs.detect

Class Naming

java.lang.Object

edu.umd.cs.findbugs.visitclass.BetterVisitor

edu.umd.cs.findbugs.visitclass.PreorderVisitor

edu.umd.cs.findbugs.detect.Naming

All Implemented Interfaces:

Detector, Priorities, org.apache.bcel.classfile.Visitor

public class Naming
extends PreorderVisitor
implements Detector

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Naming.NamingProperty

Field Summary

Fields inherited from interface edu.umd.cs.findbugs.Priorities

EXP_PRIORITY, HIGH_PRIORITY, IGNORE_PRIORITY, LOW_PRIORITY, NORMAL_PRIORITY

Constructor Summary

Constructors

Constructor	Description
Naming(BugReporter bugReporter)

Method Summary

Modifier and Type	Method	Description
static boolean	confusingMethodNamesWrongCapitalization(XMethod m1, XMethod m2)
static boolean	confusingMethodNamesWrongPackage(XMethod m1, XMethod m2)
static XMethod	definedIn(org.apache.bcel.classfile.JavaClass clazz, XMethod m)
void	report()	This method is called after all classes to be visited.
boolean	sameSimpleName(java.lang.String class1, java.lang.String class2)
java.lang.String	stripPackageName(java.lang.String className)
void	visit(org.apache.bcel.classfile.Field obj)
void	visit(org.apache.bcel.classfile.JavaClass obj)
void	visit(org.apache.bcel.classfile.Method obj)
void	visitClassContext(ClassContext classContext)	Visit the ClassContext for a class which should be analyzed for instances of bug patterns.
void	visitJavaClass(org.apache.bcel.classfile.JavaClass obj)

Methods inherited from class edu.umd.cs.findbugs.visitclass.PreorderVisitor

amVisitingMainMethod, asUnsignedByte, doVisitMethod, getClassDescriptor, getClassName, getCode, getConstantPool, getDottedClassName, getDottedFieldSig, getDottedMethodSig, getDottedSuperclassName, getField, getFieldDescriptor, getFieldIsStatic, getFieldName, getFieldSig, getFullyQualifiedFieldName, getFullyQualifiedMethodName, getMethod, getMethodDescriptor, getMethodName, getMethodSig, getMethodVisitOrder, getNumberArguments, getNumberMethodArguments, getPackageName, getSizeOfSurroundingTryBlock, getSizeOfSurroundingTryBlock, getSourceFile, getStringFromIndex, getSuperclassName, getSurroundingCaughtExceptions, getSurroundingCaughtExceptions, getSurroundingTryBlock, getSurroundingTryBlock, getThisClass, getXClass, getXField, getXMethod, hasInterestingClass, hasInterestingMethod, isVisitMethodsInCallOrder, setupVisitorForClass, setVisitMethodsInCallOrder, shouldVisit, toString, visitAfter, visitAfter, visitAnnotation, visitAnnotationDefault, visitAnnotationEntry, visitBootstrapMethods, visitCode, visitConstantInvokeDynamic, visitConstantMethodHandle, visitConstantMethodType, visitConstantModule, visitConstantPackage, visitConstantPool, visitEnclosingMethod, visitingField, visitingMethod, visitInnerClasses, visitLineNumberTable, visitLocalVariableTable, visitMethodParameters, visitParameterAnnotation, visitParameterAnnotationEntry, visitStackMap, visitStackMapEntry

Methods inherited from class edu.umd.cs.findbugs.visitclass.BetterVisitor

clone, report, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visitCodeException, visitConstantClass, visitConstantDouble, visitConstantFieldref, visitConstantFloat, visitConstantInteger, visitConstantInterfaceMethodref, visitConstantLong, visitConstantMethodref, visitConstantNameAndType, visitConstantString, visitConstantUtf8, visitConstantValue, visitDeprecated, visitExceptionTable, visitField, visitInnerClass, visitLineNumber, visitLocalVariable, visitLocalVariableTypeTable, visitMethod, visitSignature, visitSourceFile, visitSynthetic, visitUnknown

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.bcel.classfile.Visitor

visitConstantDynamic, visitMethodParameter, visitModule, visitModuleExports, visitModuleMainClass, visitModuleOpens, visitModulePackages, visitModuleProvides, visitModuleRequires, visitNestHost, visitNestMembers

Constructor Detail

Naming

public Naming(BugReporter bugReporter)

Method Detail

definedIn

@CheckForNull
public static XMethod definedIn(org.apache.bcel.classfile.JavaClass clazz,
                                XMethod m)

confusingMethodNamesWrongCapitalization

public static boolean confusingMethodNamesWrongCapitalization(XMethod m1,
                                                              XMethod m2)

confusingMethodNamesWrongPackage

public static boolean confusingMethodNamesWrongPackage(XMethod m1,
                                                       XMethod m2)

visitClassContext

public void visitClassContext(ClassContext classContext)

Description copied from interface: Detector

Visit the ClassContext for a class which should be analyzed for instances of bug patterns.

Specified by:

visitClassContext in interface Detector

Parameters:

classContext - the ClassContext

report

public void report()

Description copied from interface: Detector

This method is called after all classes to be visited. It should be used by any detectors which accumulate information over all visited classes to generate results.

Specified by:

report in interface Detector

stripPackageName

public java.lang.String stripPackageName(java.lang.String className)

sameSimpleName

public boolean sameSimpleName(java.lang.String class1,
                              java.lang.String class2)

visitJavaClass

public void visitJavaClass(org.apache.bcel.classfile.JavaClass obj)

Specified by:

visitJavaClass in interface org.apache.bcel.classfile.Visitor

Overrides:

visitJavaClass in class PreorderVisitor

visit

public void visit(org.apache.bcel.classfile.JavaClass obj)

Overrides:

visit in class BetterVisitor

visit

public void visit(org.apache.bcel.classfile.Field obj)

Overrides:

visit in class BetterVisitor

visit

public void visit(org.apache.bcel.classfile.Method obj)

Overrides:

visit in class BetterVisitor