com.mebigfatguy.fbcontrib.detect

Class ClassEnvy

java.lang.Object

edu.umd.cs.findbugs.visitclass.BetterVisitor

edu.umd.cs.findbugs.visitclass.PreorderVisitor

edu.umd.cs.findbugs.visitclass.AnnotationVisitor

edu.umd.cs.findbugs.visitclass.DismantleBytecode

edu.umd.cs.findbugs.BytecodeScanningDetector

com.mebigfatguy.fbcontrib.detect.ClassEnvy

All Implemented Interfaces:

edu.umd.cs.findbugs.Detector, edu.umd.cs.findbugs.Priorities, edu.umd.cs.findbugs.visitclass.Constants2, org.apache.bcel.classfile.Visitor, org.apache.bcel.Constants

public class ClassEnvy
extends edu.umd.cs.findbugs.BytecodeScanningDetector

finds methods that excessively use methods from another class. This probably means these methods should be defined in that other class.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Comparator<java.util.Map.Entry<java.lang.String,java.util.BitSet>>	ACCESS_COUNT_COMPARATOR
private edu.umd.cs.findbugs.BugReporter	bugReporter
private java.util.Map<java.lang.String,java.util.BitSet>	clsAccessCount
private java.lang.String	clsName
private static double	DEFAULT_ENVY_PERCENT
private static int	DEFAULT_MIN_ENVY
private static java.lang.String	ENVY_PERCENT_PROPERTY
private double	envyPercent
private static java.util.Set<java.lang.String>	ignorableInterfaces
private boolean	methodIsStatic
private java.lang.String	methodName
private int	minEnvy
private java.lang.String	packageName
private java.lang.String	parentClassName
private edu.umd.cs.findbugs.OpcodeStack	stack
private int	thisClsAccessCount

Fields inherited from class edu.umd.cs.findbugs.visitclass.DismantleBytecode

codeBytes, lineNumberTable, M_BR, M_CP, M_INT, M_PAD, M_R, M_UINT

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

EXP_PRIORITY, HIGH_PRIORITY, IGNORE_PRIORITY, LOW_PRIORITY, NORMAL_PRIORITY

Fields inherited from interface org.apache.bcel.Constants

AALOAD, AASTORE, ACC_ABSTRACT, ACC_ANNOTATION, ACC_BRIDGE, ACC_ENUM, ACC_FINAL, ACC_INTERFACE, ACC_NATIVE, ACC_PRIVATE, ACC_PROTECTED, ACC_PUBLIC, ACC_STATIC, ACC_STRICT, ACC_SUPER, ACC_SYNCHRONIZED, ACC_SYNTHETIC, ACC_SYPER, ACC_TRANSIENT, ACC_VARARGS, ACC_VOLATILE, ACCESS_NAMES, ACONST_NULL, ALOAD, ALOAD_0, ALOAD_1, ALOAD_2, ALOAD_3, ANEWARRAY, ANEWARRAY_QUICK, APPEND_FRAME, APPEND_FRAME_MAX, ARETURN, ARRAYLENGTH, ASTORE, ASTORE_0, ASTORE_1, ASTORE_2, ASTORE_3, ATHROW, ATTR_ANNOTATION_DEFAULT, ATTR_CODE, ATTR_CONSTANT_VALUE, ATTR_DEPRECATED, ATTR_ENCLOSING_METHOD, ATTR_EXCEPTIONS, ATTR_INNER_CLASSES, ATTR_LINE_NUMBER_TABLE, ATTR_LOCAL_VARIABLE_TABLE, ATTR_LOCAL_VARIABLE_TYPE_TABLE, ATTR_PMG, ATTR_RUNTIME_VISIBLE_ANNOTATIONS, ATTR_RUNTIME_VISIBLE_PARAMETER_ANNOTATIONS, ATTR_RUNTIMEIN_VISIBLE_ANNOTATIONS, ATTR_RUNTIMEIN_VISIBLE_PARAMETER_ANNOTATIONS, ATTR_SIGNATURE, ATTR_SOURCE_FILE, ATTR_STACK_MAP, ATTR_STACK_MAP_TABLE, ATTR_SYNTHETIC, ATTR_UNKNOWN, ATTRIBUTE_NAMES, BALOAD, BASTORE, BIPUSH, BREAKPOINT, CALOAD, CASTORE, CHECKCAST, CHECKCAST_QUICK, CHOP_FRAME, CHOP_FRAME_MAX, CLASS_TYPE_NAMES, CONSTANT_Class, CONSTANT_Double, CONSTANT_Fieldref, CONSTANT_Float, CONSTANT_Integer, CONSTANT_InterfaceMethodref, CONSTANT_InvokeDynamic, CONSTANT_Long, CONSTANT_MethodHandle, CONSTANT_Methodref, CONSTANT_MethodType, CONSTANT_NameAndType, CONSTANT_NAMES, CONSTANT_String, CONSTANT_Utf8, CONSTRUCTOR_NAME, CONSUME_STACK, D2F, D2I, D2L, DADD, DALOAD, DASTORE, DCMPG, DCMPL, DCONST_0, DCONST_1, DDIV, DLOAD, DLOAD_0, DLOAD_1, DLOAD_2, DLOAD_3, DMUL, DNEG, DREM, DRETURN, DSTORE, DSTORE_0, DSTORE_1, DSTORE_2, DSTORE_3, DSUB, DUP, DUP_X1, DUP_X2, DUP2, DUP2_X1, DUP2_X2, F2D, F2I, F2L, FADD, FALOAD, FASTORE, FCMPG, FCMPL, FCONST_0, FCONST_1, FCONST_2, FDIV, FLOAD, FLOAD_0, FLOAD_1, FLOAD_2, FLOAD_3, FMUL, FNEG, FREM, FRETURN, FSTORE, FSTORE_0, FSTORE_1, FSTORE_2, FSTORE_3, FSUB, FULL_FRAME, GETFIELD, GETFIELD_QUICK, GETFIELD_QUICK_W, GETFIELD2_QUICK, GETSTATIC, GETSTATIC_QUICK, GETSTATIC2_QUICK, GOTO, GOTO_W, I2B, I2C, I2D, I2F, I2L, I2S, IADD, IALOAD, IAND, IASTORE, ICONST_0, ICONST_1, ICONST_2, ICONST_3, ICONST_4, ICONST_5, ICONST_M1, IDIV, IF_ACMPEQ, IF_ACMPNE, IF_ICMPEQ, IF_ICMPGE, IF_ICMPGT, IF_ICMPLE, IF_ICMPLT, IF_ICMPNE, IFEQ, IFGE, IFGT, IFLE, IFLT, IFNE, IFNONNULL, IFNULL, IINC, ILLEGAL_OPCODE, ILLEGAL_TYPE, ILOAD, ILOAD_0, ILOAD_1, ILOAD_2, ILOAD_3, IMPDEP1, IMPDEP2, IMUL, INEG, INSTANCEOF, INSTANCEOF_QUICK, INT2BYTE, INT2CHAR, INT2SHORT, INTERFACES_IMPLEMENTED_BY_ARRAYS, INVOKEDYNAMIC, INVOKEINTERFACE, INVOKEINTERFACE_QUICK, INVOKENONVIRTUAL, INVOKENONVIRTUAL_QUICK, INVOKESPECIAL, INVOKESTATIC, INVOKESTATIC_QUICK, INVOKESUPER_QUICK, INVOKEVIRTUAL, INVOKEVIRTUAL_QUICK, INVOKEVIRTUAL_QUICK_W, INVOKEVIRTUALOBJECT_QUICK, IOR, IREM, IRETURN, ISHL, ISHR, ISTORE, ISTORE_0, ISTORE_1, ISTORE_2, ISTORE_3, ISUB, ITEM_Bogus, ITEM_Double, ITEM_Float, ITEM_InitObject, ITEM_Integer, ITEM_Long, ITEM_NAMES, ITEM_NewObject, ITEM_Null, ITEM_Object, IUSHR, IXOR, JSR, JSR_W, KNOWN_ATTRIBUTES, L2D, L2F, L2I, LADD, LALOAD, LAND, LASTORE, LCMP, LCONST_0, LCONST_1, LDC, LDC_QUICK, LDC_W, LDC_W_QUICK, LDC2_W, LDC2_W_QUICK, LDIV, LLOAD, LLOAD_0, LLOAD_1, LLOAD_2, LLOAD_3, LMUL, LNEG, LOOKUPSWITCH, LOR, LREM, LRETURN, LSHL, LSHR, LSTORE, LSTORE_0, LSTORE_1, LSTORE_2, LSTORE_3, LSUB, LUSHR, LXOR, MAJOR, MAJOR_1_1, MAJOR_1_2, MAJOR_1_3, MAJOR_1_4, MAJOR_1_5, MAJOR_1_6, MAJOR_1_7, MAJOR_1_8, MAX_ACC_FLAG, MAX_BYTE, MAX_CODE_SIZE, MAX_CP_ENTRIES, MAX_SHORT, MINOR, MINOR_1_1, MINOR_1_2, MINOR_1_3, MINOR_1_4, MINOR_1_5, MINOR_1_6, MINOR_1_7, MINOR_1_8, MONITORENTER, MONITOREXIT, MULTIANEWARRAY, MULTIANEWARRAY_QUICK, NEW, NEW_QUICK, NEWARRAY, NO_OF_OPERANDS, NOP, OPCODE_NAMES, POP, POP2, PRODUCE_STACK, PUSH, PUTFIELD, PUTFIELD_QUICK, PUTFIELD_QUICK_W, PUTFIELD2_QUICK, PUTSTATIC, PUTSTATIC_QUICK, PUTSTATIC2_QUICK, RESERVED, RET, RETURN, SALOAD, SAME_FRAME, SAME_FRAME_EXTENDED, SAME_FRAME_MAX, SAME_LOCALS_1_STACK_ITEM_FRAME, SAME_LOCALS_1_STACK_ITEM_FRAME_EXTENDED, SAME_LOCALS_1_STACK_ITEM_FRAME_MAX, SASTORE, SHORT_TYPE_NAMES, SIPUSH, STATIC_INITIALIZER_NAME, SWAP, SWITCH, T_ADDRESS, T_ARRAY, T_BOOLEAN, T_BYTE, T_CHAR, T_DOUBLE, T_FLOAT, T_INT, T_LONG, T_OBJECT, T_REFERENCE, T_SHORT, T_UNKNOWN, T_VOID, TABLESWITCH, TYPE_NAMES, TYPE_OF_OPERANDS, UNDEFINED, UNPREDICTABLE, WIDE

Constructor Summary

Constructors

Constructor and Description
ClassEnvy(edu.umd.cs.findbugs.BugReporter bugReporter) constructs a CE detector given the reporter to report bugs on

Method Summary

Modifier and Type	Method and Description
private void	addLineNumber(java.util.BitSet lineNumbers) add the current line number to a set of line numbers
private boolean	countClassAccess(int classAtStackIndex) increment the count of class access of the class on the stack
private void	countClassAccess(java.lang.String calledClass) increment the count of class access of the specified class if it is in a similar package to the caller, and is not general purpose
private boolean	generalPurpose(java.lang.String className) checks to see if the specified class is a built in class, or implements a simple interface
private boolean	implementsCommonInterface(java.lang.String name) return whether or not a class implements a common or marker interface
private boolean	isAssociatedClass(java.lang.String calledClass) returns whether the called class is an inner class, or super class of the current class
void	sawOpcode(int seen) overrides the visitor to look for method calls, and populate a class access count map based on the owning class of methods called.
void	visitClassContext(edu.umd.cs.findbugs.ba.ClassContext classContext) overrides the visitor to collect package and class names
void	visitCode(org.apache.bcel.classfile.Code obj) overrides the visitor to look for the method that uses another class the most, and if it exceeds the threshold reports it
void	visitMethod(org.apache.bcel.classfile.Method obj) overrides the visitor to check whether the method is static

Methods inherited from class edu.umd.cs.findbugs.BytecodeScanningDetector

getClassContext, report, shouldVisitCode

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

afterOpcode, areOppositeBranches, atCatchBlock, beforeOpcode, getBranchFallThrough, getBranchOffset, getBranchTarget, getClassConstantOperand, getClassDescriptorOperand, getCodeByte, getConstantRefOperand, getDefaultSwitchOffset, getDottedClassConstantOperand, getFieldDescriptorOperand, getIntConstant, getLongConstant, getMaxPC, getMethodDescriptorOperand, getNameConstantOperand, getNextCodeByte, getNextOpcode, getNextPC, getOpcode, getPC, getPrevOpcode, getRefConstantOperand, getRefFieldIsStatic, getRegisterOperand, getSigConstantOperand, getStringConstantOperand, getSwitchLabels, getSwitchOffsets, getXClassOperand, getXFieldOperand, getXMethodOperand, isBranch, isMethodCall, isRegisterLoad, isRegisterStore, isRegisterStore, isReturn, isShift, isSwitch, isWideOpcode, printOpCode, sawBranchTo, sawClass, sawDouble, sawField, sawFloat, sawIMethod, sawInt, sawLong, sawMethod, sawRegister, sawString, visit

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

getAnnotationParameterAsString, getAnnotationParameterAsStringArray, visitAnnotation, visitAnnotation, visitParameterAnnotation, visitParameterAnnotation, visitSyntheticParameterAnnotation

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, visitAnnotationDefault, visitAnnotationEntry, visitConstantPool, visitEnclosingMethod, visitingField, visitingMethod, visitInnerClasses, visitJavaClass, visitLineNumberTable, visitLocalVariableTable, visitStackMapTable, visitStackMapTableEntry

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, visit, visit, visitCodeException, visitConstantClass, visitConstantDouble, visitConstantFieldref, visitConstantFloat, visitConstantInteger, visitConstantInterfaceMethodref, visitConstantLong, visitConstantMethodref, visitConstantNameAndType, visitConstantString, visitConstantUtf8, visitConstantValue, visitDeprecated, visitExceptionTable, visitField, visitInnerClass, visitLineNumber, visitLocalVariable, visitLocalVariableTypeTable, visitSignature, visitSourceFile, visitStackMap, visitStackMapEntry, visitSynthetic, visitUnknown

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ENVY_PERCENT

private static final double DEFAULT_ENVY_PERCENT

See Also:

Constant Field Values

DEFAULT_MIN_ENVY

private static final int DEFAULT_MIN_ENVY

See Also:

Constant Field Values

ENVY_PERCENT_PROPERTY

private static final java.lang.String ENVY_PERCENT_PROPERTY

See Also:

Constant Field Values

ignorableInterfaces

private static final java.util.Set<java.lang.String> ignorableInterfaces

ACCESS_COUNT_COMPARATOR

private static final java.util.Comparator<java.util.Map.Entry<java.lang.String,java.util.BitSet>> ACCESS_COUNT_COMPARATOR

bugReporter

private final edu.umd.cs.findbugs.BugReporter bugReporter

stack

private edu.umd.cs.findbugs.OpcodeStack stack

packageName

private java.lang.String packageName

clsName

@DottedClassName
private java.lang.String clsName

parentClassName

@DottedClassName
private java.lang.String parentClassName

clsAccessCount

private java.util.Map<java.lang.String,java.util.BitSet> clsAccessCount

thisClsAccessCount

private int thisClsAccessCount

methodName

private java.lang.String methodName

methodIsStatic

private boolean methodIsStatic

envyPercent

private double envyPercent

minEnvy

private int minEnvy

Constructor Detail

ClassEnvy

public ClassEnvy(edu.umd.cs.findbugs.BugReporter bugReporter)

constructs a CE detector given the reporter to report bugs on

Parameters:

bugReporter - the sync of bug reports

Method Detail

visitClassContext

public void visitClassContext(edu.umd.cs.findbugs.ba.ClassContext classContext)

overrides the visitor to collect package and class names

Specified by:

visitClassContext in interface edu.umd.cs.findbugs.Detector

Overrides:

visitClassContext in class edu.umd.cs.findbugs.BytecodeScanningDetector

Parameters:

classContext - the context object that holds the JavaClass being parsed

visitMethod

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

overrides the visitor to check whether the method is static

Specified by:

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

Overrides:

visitMethod in class edu.umd.cs.findbugs.visitclass.BetterVisitor

Parameters:

obj - the method currently being parsed

visitCode

public void visitCode(org.apache.bcel.classfile.Code obj)

overrides the visitor to look for the method that uses another class the most, and if it exceeds the threshold reports it

Specified by:

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

Overrides:

visitCode in class edu.umd.cs.findbugs.visitclass.PreorderVisitor

Parameters:

obj - the code that is currently being parsed

sawOpcode

public void sawOpcode(int seen)

overrides the visitor to look for method calls, and populate a class access count map based on the owning class of methods called.

Overrides:

sawOpcode in class edu.umd.cs.findbugs.visitclass.DismantleBytecode

Parameters:

seen - the opcode currently being parsed

implementsCommonInterface

private boolean implementsCommonInterface(java.lang.String name)

return whether or not a class implements a common or marker interface

Parameters:

name - the class name to check

Returns:

if this class implements a common or marker interface

countClassAccess

private boolean countClassAccess(int classAtStackIndex)

increment the count of class access of the class on the stack

Parameters:

classAtStackIndex - the position on the stack of the class in question

Returns:

true if the class is counted

countClassAccess

private void countClassAccess(@DottedClassName
                              java.lang.String calledClass)

increment the count of class access of the specified class if it is in a similar package to the caller, and is not general purpose

Parameters:

calledClass - the class to check

isAssociatedClass

private boolean isAssociatedClass(@DottedClassName
                                  java.lang.String calledClass)

returns whether the called class is an inner class, or super class of the current class

Parameters:

calledClass - the class to check

Returns:

if the class is related to this class

addLineNumber

private void addLineNumber(java.util.BitSet lineNumbers)

add the current line number to a set of line numbers

Parameters:

lineNumbers - the current set of line numbers

generalPurpose

private boolean generalPurpose(java.lang.String className)

checks to see if the specified class is a built in class, or implements a simple interface

Parameters:

className - the class in question

Returns:

whether or not the class is general purpose