svn commit: r1661240 - /commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/InstructionTargeter.java

[eb...@apache.org]

Author: ebourg
Date: Fri Feb 20 23:17:15 2015
New Revision: 1661240

URL: http://svn.apache.org/r1661240
Log:
Javadoc improvement for InstructionTargeter, thanks to Thiago Bartolomei (BCEL-161)

Modified:
    commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/InstructionTargeter.java

Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/InstructionTargeter.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/InstructionTargeter.java?rev=1661240&r1=1661239&r2=1661240&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/InstructionTargeter.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/InstructionTargeter.java Fri Feb 20 23:17:15 2015
@@ -15,6 +15,7 @@
  *  limitations under the License.
  *
  */
+
 package org.apache.bcel.generic;
 
 /**
@@ -29,8 +30,17 @@ package org.apache.bcel.generic;
  */
 public interface InstructionTargeter {
 
-    boolean containsTarget( InstructionHandle ih );
-
+    /**
+     * Checks whether this targeter targets the specified instruction handle.
+     */
+    boolean containsTarget(InstructionHandle ih);
 
-    void updateTarget( InstructionHandle old_ih, InstructionHandle new_ih );
+    /**
+     * Replaces the target of this targeter from this old handle to the new handle.
+     *
+     * @param old_ih the old handle
+     * @param new_ih the new handle
+     * @throws ClassGenException if old_ih is not targeted by this object
+     */
+    void updateTarget(InstructionHandle old_ih, InstructionHandle new_ih) throws ClassGenException;
 }