Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * fb-contrib - Auxiliary detectors for Java programs
   * Copyright (C) 2005-2014 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.List;
 import java.util.Map;
 import java.util.Set;
 
 import  org.apache.bcel.Constants;
 import  org.apache.bcel.classfile.Code;
 import  org.apache.bcel.classfile.JavaClass;
 import  org.apache.bcel.classfile.Method;
 import  org.apache.bcel.generic.Type;
 
looks for constructors of non final classes that make method calls to non final methods. As these methods could be overridden, the overridden method will be accessing an object that is only partially constructed, perhaps causing problems.
 
 public class PartiallyConstructedObjectAccess extends BytecodeScanningDetector
 {
 	private final BugReporter bugReporter;
 	private OpcodeStack stack;
 	private Map<Method, Map<Method, SourceLineAnnotation>> methodToCalledMethods;
 	private boolean reportedCtor;
 	private boolean isCtor;

constructs a PCOA detector given the reporter to report bugs on

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

implements the visitor to set up the stack and methodToCalledmethods map reports calls to public non final methods from methods called from constructors.

Parameters:
classContext the context object of the currently parsed class
 
 	public void visitClassContext(final ClassContext classContext) {
 		try {
 			JavaClass cls = classContext.getJavaClass();
 			if ((cls.getAccessFlags() & Constants.ACC_FINAL) == 0) {
 				 = new OpcodeStack();
 				 = new HashMap<Method, Map<Method, SourceLineAnnotation>>();
 				super.visitClassContext(classContext);
 				
 				if (.size() > 0)
 			}
 		} finally {
 			 = null;
 		}
 	}
 	
 	public void visitCode(final Code obj) {
 		String methodName = getMethodName();
 		 = "<init>".equals(methodName);
 		
 		if (!"<clinit>".equals(methodName)) {
 			Method m = getMethod();
 			 = false;
 			
 			super.visitCode(obj);
 			if ( || (.get(m).isEmpty()))
		}
	}
	public void sawOpcode(int seen) {
			return;
		try {
	        .precomputation(this);
			if ((seen == INVOKEVIRTUAL) || (seen == INVOKEINTERFACE) || (seen == INVOKESPECIAL)) {
				int parmCount = Type.getArgumentTypes(getSigConstantOperand()).length;
				if (.getStackDepth() > parmCount) {
					OpcodeStack.Item itm = .getStackItem(parmCount);
					if (itm.getRegisterNumber() == 0) {
						JavaClass cls = itm.getJavaClass();
						if (cls != null) {
							if (m != null) {
								if ((m.getAccessFlags() & Constants.ACC_FINAL) == 0) {
									if ( && (seen != INVOKESPECIAL)) {
										.reportBugnew BugInstance(this"PCOA_PARTIALLY_CONSTRUCTED_OBJECT_ACCESS", NORMAL_PRIORITY)
											.addClass(this)
											.addMethod(this)
											.addSourceLine(thisgetPC()));
										 = true;
else {
										if (!"<init>".equals(m.getName())) {
											Map<Method, SourceLineAnnotationcalledMethods = .get(getMethod());
											calledMethods.put(m, SourceLineAnnotation.fromVisitedInstruction(this));
										}
									}
								}
							}
						}
					}
				}
			}
catch (ClassNotFoundException cnfe) {
finally {
			.sawOpcode(thisseen);
		}
	}
	private Method findMethod(final JavaClass clsfinal String methodNamefinal String methodSig) {
		Method[] methods = cls.getMethods();
		for (Method m : methods) {
			if (methodName.equals(m.getName()) && methodSig.equals(m.getSignature())) {
				return m;
			}
		}
		return null;
	}
	private void reportChainedMethods() {
		Set<Method> checkedMethods = new HashSet<Method>();
		JavaClass cls = getClassContext().getJavaClass();
		for (Map.Entry<Method, Map<Method, SourceLineAnnotation>> entry : .entrySet()) {
			Method m = entry.getKey();
			if ("<init>".equals(m.getName())) {
				checkedMethods.clear();
				List<SourceLineAnnotationslas = foundPrivateInChain(mcheckedMethods);
				if (slas != null) {
					BugInstance bi = new BugInstance(this"PCOA_PARTIALLY_CONSTRUCTED_OBJECT_ACCESS", LOW_PRIORITY)
							.addMethod(clsm);
				    for (SourceLineAnnotation sla : slas)
				}
			}
		}
	}
	private List<SourceLineAnnotationfoundPrivateInChain(Method mSet<Method> checkedMethods) {
		Map<Method, SourceLineAnnotationcalledMethods = .get(m);
		if (calledMethods != null) {
			for (Map.Entry<Method, SourceLineAnnotationentry : calledMethods.entrySet()) {
				Method cm = entry.getKey();
				if (checkedMethods.contains(cm))
					continue;
				if (!cm.isPrivate() && (cm.getAccessFlags() & Constants.ACC_FINAL) == 0) {
					slas.add(entry.getValue());
					return slas;
				}
				checkedMethods.add(cm);
				List<SourceLineAnnotationslas = foundPrivateInChain(cmcheckedMethods);
				if (slas != null) {
					slas.add(0, entry.getValue());
					return slas;
				}
			}
		}
		return null;
	}
New to GrepCode? Check out our FAQ X