Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * fb-contrib - Auxiliary detectors for Java programs
   * Copyright (C) 2005-2013 Dave Brosius
   * 
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU Lesser General Public
   * License as published by the Free Software Foundation; either
   * version 2.1 of the License, or (at your option) any later version.
   * 
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  * 
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 package com.mebigfatguy.fbcontrib.detect;
 
 import java.util.Map;
 import java.util.Set;
 
 import  org.apache.bcel.classfile.Code;
 import  org.apache.bcel.classfile.JavaClass;
 
 
 import  edu.umd.cs.findbugs.BugInstance;
 import  edu.umd.cs.findbugs.BugReporter;
 import  edu.umd.cs.findbugs.BytecodeScanningDetector;
 import  edu.umd.cs.findbugs.OpcodeStack;
 import  edu.umd.cs.findbugs.SourceLineAnnotation;
 import  edu.umd.cs.findbugs.ba.ClassContext;
 import  edu.umd.cs.findbugs.ba.XField;

looks for collections or arrays that hold objects that are unrelated thru class or interface inheritance other than java.lang.Object. Doing so, makes for brittle code, relying either on positional correspondence for type, or a reliance on instanceof to determine type. A better design usually can be had by creating a seperate class, which defines the different types required, and add an instance of that class to the collection, or array.
 
 public class UnrelatedCollectionContents extends BytecodeScanningDetector
 {
 	private static final Set<StringCOLLECTION_CLASSES = new HashSet<String>();
 	static {
 		.add("java/util/Collection");
 		.add("java/util/List");
 		.add("java/util/Map");
 		.add("java/util/Set");
 		.add("java/util/SortedMap");
 		.add("java/util/SortedSet");
 	}
 	private final BugReporter bugReporter;
 	private OpcodeStack stack;
 	private Map<StringSet<SourceLineAnnotation>>memberSourceLineAnnotations;
 	private Map<IntegerSet<SourceLineAnnotation>>localSourceLineAnnotations;

constructs a UCC detector given the reporter to report bugs on

Parameters:
bugReporter the sync of bug reports
 
 	public UnrelatedCollectionContents(final BugReporter bugReporter) {
 		this. = bugReporter;
 	}

implements the visitor to create and destroy the stack and member collections

Parameters:
classContext the context object for the currently parsed class
 
 	public void visitClassContext(final ClassContext classContext) {
 		try {
 			 = new OpcodeStack();
 			 = new HashMap<StringSet<SourceLineAnnotation>>();
 			super.visitClassContext(classContext);
 		} finally {
 			 = null;
 			 = null;
 		}
 	}
 	
 	public void visitCode(final Code obj) {
 		try {
 			 = new HashMap<IntegerSet<SourceLineAnnotation>>();
			.resetForMethodEntry(this);
			super.visitCode(obj);
finally {
		}
	}
	public void sawOpcode(final int seen) {
		try {
	        .precomputation(this);
			Set<Integerregs = .remove(Integer.valueOf(getPC()));
			if (regs != null) {
				for (Integer i : regs) {
				}
			}
			if (seen == INVOKEINTERFACE) {
				if (.contains(className)) {
					String methodName = getNameConstantOperand();
					String methodSig = getSigConstantOperand();
					if ("add".equals(methodName) && "(Ljava/lang/Object;)Z".equals(methodSig)) {
						if (.getStackDepth() > 1) {
							OpcodeStack.Item colItm = .getStackItem(1);
							OpcodeStack.Item addItm = .getStackItem(0);
							checkAdd(colItmaddItm);
					}
else if ("put".equals(methodName) && "(Ljava/lang/Object;Ljava/lang/Object;)Z".equals(methodSig)) {
						if (.getStackDepth() > 2) {
							//For maps, just check the keys
							OpcodeStack.Item colItm = .getStackItem(2);
							OpcodeStack.Item addItm = .getStackItem(1);
							checkAdd(colItmaddItm);
						}
					}
				}
else if (seen == AASTORE) {
				if (.getStackDepth() > 2) {
					OpcodeStack.Item arrayItm = .getStackItem(2);
					OpcodeStack.Item addItm = .getStackItem(0);
					checkAdd(arrayItmaddItm);
				}
else if (seen == ASTORE) {
				Integer reg = Integer.valueOf(RegisterUtils.getAStoreReg(thisseen));
			}
catch (ClassNotFoundException cnfe) {
			.reportMissingClass(cnfe);
finally {
			.sawOpcode(thisseen);
		}
	}
	private void checkAdd(final OpcodeStack.Item colItmfinal OpcodeStack.Item addItm
		int reg = colItm.getRegisterNumber();
		if (reg != -1) {
			Set<SourceLineAnnotation> pcs = .get(Integer.valueOf(reg));
			if (pcs == null) {
				pcs = new HashSet<SourceLineAnnotation>();
				.put(Integer.valueOf(reg), pcs);
			}
			pcs.add(SourceLineAnnotation.fromVisitedInstruction(thisgetPC()));
			Set<StringcommonSupers = .get(Integer.valueOf(reg));
			if (commonSupers != null)
				mergeItem(commonSuperspcsaddItm);
			else {
				commonSupers = new HashSet<String>();
				.put(Integer.valueOf(reg), commonSupers);
				addNewItem(commonSupersaddItm);
				Integer scopeEnd = Integer.valueOf(RegisterUtils.getLocalVariableEndRange(getMethod().getLocalVariableTable(), reggetNextPC()));
				Set<Integerregs = .get(scopeEnd);
                if (regs == null) {
                    regs = new HashSet<Integer>();
                    .put(scopeEndregs);
                }
                regs.add(Integer.valueOf(reg));
			}
else {
			XField field = colItm.getXField();
			if (field == null)
				return;
			Set<SourceLineAnnotation> sla = .get(field.getName());
			if (sla == null) {
				sla = new HashSet<SourceLineAnnotation>();
				.put(field.getName(), sla);
			}
			sla.add(SourceLineAnnotation.fromVisitedInstruction(this));
			Set<StringcommonSupers = .get(field.getName());
			if (commonSupers != null)
				mergeItem(commonSupersslaaddItm);
			else {
				commonSupers = new HashSet<String>();
				.put(field.getName(), commonSupers);
				addNewItem(commonSupersaddItm);
			}
		}
	}
	private void mergeItem(final Set<Stringsupersfinal Set<SourceLineAnnotation> slafinal OpcodeStack.Item addItm
		if (supers.isEmpty())
			return;
		Set<Strings = new HashSet<String>();
		addNewItem(saddItm);
		if (s.isEmpty())
			return;
		intersection(superss);
		if (supers.isEmpty()) {
			BugInstance bug = new BugInstance(this"UCC_UNRELATED_COLLECTION_CONTENTS", NORMAL_PRIORITY)
				.addClass(this);
			if (addItm.getRegisterNumber() != -1)
				bug.addMethod(this);
			for (SourceLineAnnotation a : sla) {
				bug.addSourceLine(a);
			}
			.reportBug(bug);
		}
	}
	private void addNewItem(final Set<Stringsupersfinal OpcodeStack.Item addItm
		String itemSignature = addItm.getSignature();
		if (itemSignature.length() == 0)
			return;
		if (itemSignature.charAt(0) == '[') {
			supers.add(itemSignature);
			return;
		}
		JavaClass cls = addItm.getJavaClass();
		if ((cls == null) || "java.lang.Object".equals(cls.getClassName()))
			return;
		supers.add(cls.getClassName());
		JavaClass[] infs = cls.getAllInterfaces();
		for (JavaClass inf : infs) {
			String infName = inf.getClassName();
			if (!"java.io.Serializable".equals(infName)
			&&  !"java.lang.Cloneable".equals(infName))
				supers.add(inf.getClassName());	
		}
		JavaClass[] sups = cls.getSuperClasses();
		for (JavaClass sup : sups) {
			String name = sup.getClassName();
			if (!"java.lang.Object".equals(name))
				supers.add(name);
		}
	}
	private static void intersection(final Set<Stringorigfinal Set<Stringadd) {
		Iterator<Stringit = orig.iterator();
		while (it.hasNext()) {
			if (!add.contains(it.next()))
				it.remove();			
		}
	}
New to GrepCode? Check out our FAQ X