From 7093e8fac6b10a23eb8df9094dfe8b4759a26c79 Mon Sep 17 00:00:00 2001 From: sjfink Date: Fri, 12 Jun 2009 14:41:28 +0000 Subject: [PATCH] tweak comments git-svn-id: https://wala.svn.sourceforge.net/svnroot/wala/trunk@3662 f5eafffb-2e1d-0410-98e4-8ec43c5233c4 --- .../AbstractReflectionInterpreter.java | 2 -- .../wala/analysis/reflection/CallSiteMap.java | 7 +------ .../ClassNewInstanceContextSelector.java | 2 -- .../reflection/FactoryContextSelector.java | 3 --- .../reflection/GetClassContextSelector.java | 13 +++++-------- .../IllegalArgumentExceptionContext.java | 5 +---- .../reflection/InstanceKeyWithNode.java | 2 -- .../JavaLangClassContextInterpreter.java | 3 --- .../ReflectionContextInterpreter.java | 1 - .../reflection/ReflectionContextSelector.java | 2 -- .../ReflectiveInvocationSelector.java | 18 +++++++----------- 11 files changed, 14 insertions(+), 44 deletions(-) diff --git a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/AbstractReflectionInterpreter.java b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/AbstractReflectionInterpreter.java index b83477c41..44206c5dc 100644 --- a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/AbstractReflectionInterpreter.java +++ b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/AbstractReflectionInterpreter.java @@ -42,8 +42,6 @@ import com.ibm.wala.util.warnings.Warning; /** * An abstract superclass of various {@link SSAContextInterpreter}s that deal with reflection methods. - * - * @author pistoia */ public abstract class AbstractReflectionInterpreter implements SSAContextInterpreter { diff --git a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/CallSiteMap.java b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/CallSiteMap.java index a0b330c32..c4bc73a1a 100644 --- a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/CallSiteMap.java +++ b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/CallSiteMap.java @@ -20,10 +20,7 @@ import com.ibm.wala.ssa.SSAInstruction.Visitor; import com.ibm.wala.util.collections.HashMapFactory; /** - * - * A mapping from CallSiteReference to SSA InvokeInstruction. - * - * @author sfink + * A mapping from {@link CallSiteReference} to {@link SSAInvokeInstruction} */ public class CallSiteMap { @@ -33,7 +30,6 @@ public class CallSiteMap { private final Map map = HashMapFactory.make(); /** - * @param ir * @throws IllegalArgumentException if ir is null */ public CallSiteMap(final IR ir) { @@ -56,7 +52,6 @@ public class CallSiteMap { } /** - * @param site * @return the InvokeInstruction corresponding to the call site. */ public SSAInvokeInstruction getInstructionForSite(CallSiteReference site) { diff --git a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/ClassNewInstanceContextSelector.java b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/ClassNewInstanceContextSelector.java index 3b0351a12..5b04fc49e 100644 --- a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/ClassNewInstanceContextSelector.java +++ b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/ClassNewInstanceContextSelector.java @@ -22,8 +22,6 @@ import com.ibm.wala.ipa.callgraph.propagation.InstanceKey; /** * A {@link ContextSelector} to intercept calls to Class.newInstance() - * - * @author pistoia */ class ClassNewInstanceContextSelector implements ContextSelector { diff --git a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/FactoryContextSelector.java b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/FactoryContextSelector.java index 8c4eb6765..c6f2fa034 100644 --- a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/FactoryContextSelector.java +++ b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/FactoryContextSelector.java @@ -22,12 +22,9 @@ import com.ibm.wala.ipa.callgraph.propagation.cfa.CallStringContext; /** * For synthetic methods marked as "Factories", we analyze in a context defined by the caller. - * - * @author sfink */ class FactoryContextSelector implements ContextSelector { - public FactoryContextSelector() { } diff --git a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/GetClassContextSelector.java b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/GetClassContextSelector.java index fe4f47c05..c47d565a8 100644 --- a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/GetClassContextSelector.java +++ b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/GetClassContextSelector.java @@ -21,20 +21,17 @@ import com.ibm.wala.types.MethodReference; import com.ibm.wala.types.TypeReference; /** - * A {@link ContextSelector} to intercept calls to Object.getClass() - * - * @author sjfink + * A {@link ContextSelector} to intercept calls to Object.getClass() */ class GetClassContextSelector implements ContextSelector { - - public final static MethodReference GET_CLASS = MethodReference.findOrCreate(TypeReference.JavaLangObject, "getClass", "()Ljava/lang/Class;"); + + public final static MethodReference GET_CLASS = MethodReference.findOrCreate(TypeReference.JavaLangObject, "getClass", + "()Ljava/lang/Class;"); public GetClassContextSelector() { } - - /** - * + /* * @see com.ibm.wala.ipa.callgraph.ContextSelector#getCalleeTarget(com.ibm.wala.ipa.callgraph.CGNode, * com.ibm.wala.classLoader.CallSiteReference, com.ibm.wala.classLoader.IMethod, * com.ibm.wala.ipa.callgraph.propagation.InstanceKey) diff --git a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/IllegalArgumentExceptionContext.java b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/IllegalArgumentExceptionContext.java index 63bccdb3a..6553bd640 100644 --- a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/IllegalArgumentExceptionContext.java +++ b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/IllegalArgumentExceptionContext.java @@ -14,10 +14,7 @@ import com.ibm.wala.ipa.callgraph.Context; import com.ibm.wala.ipa.callgraph.ContextItem; import com.ibm.wala.ipa.callgraph.ContextKey; -/** - * @author fink - * @author pistoia - */ + public class IllegalArgumentExceptionContext implements Context { public ContextItem get(ContextKey name) { diff --git a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/InstanceKeyWithNode.java b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/InstanceKeyWithNode.java index 83f5d6b3f..40613f934 100644 --- a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/InstanceKeyWithNode.java +++ b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/InstanceKeyWithNode.java @@ -15,8 +15,6 @@ import com.ibm.wala.ipa.callgraph.propagation.InstanceKey; /** * An instance key which has an associated {@link CGNode}. - * - * @author sfink */ public interface InstanceKeyWithNode extends InstanceKey { diff --git a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/JavaLangClassContextInterpreter.java b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/JavaLangClassContextInterpreter.java index 32e3e9285..f0428c103 100644 --- a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/JavaLangClassContextInterpreter.java +++ b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/JavaLangClassContextInterpreter.java @@ -58,9 +58,6 @@ import com.ibm.wala.util.debug.Assertions; *
  • getDeclaredMethod *
  • getDeclaredMethods * - * - * @author pistoia - * @author sfink */ public class JavaLangClassContextInterpreter implements SSAContextInterpreter { diff --git a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/ReflectionContextInterpreter.java b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/ReflectionContextInterpreter.java index ce3784f3f..ff7719ee1 100644 --- a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/ReflectionContextInterpreter.java +++ b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/ReflectionContextInterpreter.java @@ -31,7 +31,6 @@ import com.ibm.wala.types.FieldReference; /** * {@link SSAContextInterpreter} to handle all reflection procession. - * */ public class ReflectionContextInterpreter { diff --git a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/ReflectionContextSelector.java b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/ReflectionContextSelector.java index f845055b0..7526cfa9a 100644 --- a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/ReflectionContextSelector.java +++ b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/ReflectionContextSelector.java @@ -21,8 +21,6 @@ import com.ibm.wala.ipa.callgraph.propagation.InstanceKey; /** * A {@link ContextSelector} to handle default reflection logic. - * - * @author sjfink */ public class ReflectionContextSelector { diff --git a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/ReflectiveInvocationSelector.java b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/ReflectiveInvocationSelector.java index 430ff98e1..daf8e0b3d 100644 --- a/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/ReflectiveInvocationSelector.java +++ b/com.ibm.wala.core/src/com/ibm/wala/analysis/reflection/ReflectiveInvocationSelector.java @@ -26,11 +26,7 @@ import com.ibm.wala.ssa.SymbolTable; import com.ibm.wala.types.TypeReference; /** - * A {@link ContextSelector} to intercept calls to reflective method invocations such as Constructor.newInstance and - * Method.invoke - * - * @author pistoia - * @author sjfink + * A {@link ContextSelector} to intercept calls to reflective method invocations such as Constructor.newInstance and Method.invoke */ class ReflectiveInvocationSelector implements ContextSelector { @@ -40,12 +36,12 @@ class ReflectiveInvocationSelector implements ContextSelector { /** * Creates a callee target based on the following criteria: *
      - *
    1. If the method being invoked through reflection is definitely static, then do not create a callee target for - * any callee method that is not static. In this case, return null. - *
    2. If the method being invoked through reflection takes a constant number of parameters, n, then - * do not create a callee target for any callee method that takes a number of parameters different from - * n. In this case, return null. - *
    3. Otherwise, return a new {@link ReceiverInstanceContext} for receiver. + *
    4. If the method being invoked through reflection is definitely static, then do not create a callee target for any + * callee method that is not static. In this case, return null. + *
    5. If the method being invoked through reflection takes a constant number of parameters, n, then do not create a + * callee target for any callee method that takes a number of parameters different from n. In this case, + * return null. + *
    6. Otherwise, return a new {@link ReceiverInstanceContext} for receiver. *
    */ public Context getCalleeTarget(CGNode caller, CallSiteReference site, IMethod callee, InstanceKey receiver) {