You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by se...@apache.org on 2015/08/25 23:19:28 UTC

svn commit: r1697772 - in /commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/generic: Instruction.java InstructionConstants.java

Author: sebb
Date: Tue Aug 25 21:19:28 2015
New Revision: 1697772

URL: http://svn.apache.org/r1697772
Log:
Docs

Modified:
    commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/generic/Instruction.java
    commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/generic/InstructionConstants.java

Modified: commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/generic/Instruction.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/generic/Instruction.java?rev=1697772&r1=1697771&r2=1697772&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/generic/Instruction.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/generic/Instruction.java Tue Aug 25 21:19:28 2015
@@ -148,9 +148,12 @@ public abstract class Instruction implem
     /**
      * Read an instruction from (byte code) input stream and return the
      * appropiate object.
-     *
+     * <p>
+     * If the Instruction is defined in {@link InstructionConstants}, then the
+     * singleton instance is returned.
      * @param bytes input stream bytes
      * @return instruction object being read
+     * @see InstructionConstants#getInstruction(int)
      */
     // @since 6.0 no longer final
     public static Instruction readInstruction( ByteSequence bytes ) throws IOException {

Modified: commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/generic/InstructionConstants.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/generic/InstructionConstants.java?rev=1697772&r1=1697771&r2=1697772&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/generic/InstructionConstants.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/generic/InstructionConstants.java Tue Aug 25 21:19:28 2015
@@ -39,6 +39,10 @@ public class InstructionConstants {
 
     /** Predefined instruction objects
      */
+    /*
+     * NOTE these are not currently immutable, because Instruction
+     * has mutable protected fields opcode and length.
+     */
     public static final Instruction NOP = new NOP();
     public static final Instruction ACONST_NULL = new ACONST_NULL();
     public static final Instruction ICONST_M1 = new ICONST(-1);