From 4e6b402acd2b632b4dfd475f9acb5d60ba272695 Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Fri, 21 Feb 2025 17:53:24 -0500 Subject: [PATCH] Javadoc --- .../compressors/bzip2/BZip2Constants.java | 39 +++++++++++++ .../compress/harmony/pack200/BandSet.java | 2 +- .../pack200/CanonicalCodecFamilies.java | 57 +++++++++++++++++++ .../bytecode/forms/ByteCodeForm.java | 8 +-- .../unpack200/bytecode/forms/ByteForm.java | 7 +++ .../bytecode/forms/ClassRefForm.java | 15 +++++ .../forms/ClassSpecificReferenceForm.java | 7 +++ .../unpack200/bytecode/forms/DoubleForm.java | 7 +++ .../bytecode/forms/FieldRefForm.java | 7 +++ .../bytecode/forms/FloatRefForm.java | 15 +++++ .../bytecode/forms/IMethodRefForm.java | 7 +++ .../unpack200/bytecode/forms/IincForm.java | 7 +++ .../forms/InitMethodReferenceForm.java | 7 +++ .../unpack200/bytecode/forms/IntRefForm.java | 15 +++++ .../unpack200/bytecode/forms/LabelForm.java | 15 +++++ .../unpack200/bytecode/forms/LocalForm.java | 7 +++ .../unpack200/bytecode/forms/LongForm.java | 7 +++ .../bytecode/forms/LookupSwitchForm.java | 6 ++ .../bytecode/forms/MethodRefForm.java | 7 +++ .../bytecode/forms/MultiANewArrayForm.java | 7 +++ .../bytecode/forms/NarrowClassRefForm.java | 15 +++++ .../bytecode/forms/NewClassRefForm.java | 7 +++ .../bytecode/forms/NewInitMethodRefForm.java | 7 +++ .../bytecode/forms/NoArgumentForm.java | 6 ++ .../bytecode/forms/ReferenceForm.java | 7 +++ .../unpack200/bytecode/forms/ShortForm.java | 7 +++ .../forms/SingleByteReferenceForm.java | 7 +++ .../bytecode/forms/StringRefForm.java | 15 +++++ .../bytecode/forms/SuperFieldRefForm.java | 7 +++ .../forms/SuperInitMethodRefForm.java | 7 +++ .../bytecode/forms/SuperMethodRefForm.java | 7 +++ .../unpack200/bytecode/forms/SwitchForm.java | 6 ++ .../bytecode/forms/TableSwitchForm.java | 6 ++ .../bytecode/forms/ThisFieldRefForm.java | 7 +++ .../bytecode/forms/ThisInitMethodRefForm.java | 7 +++ .../bytecode/forms/ThisMethodRefForm.java | 7 +++ .../forms/VariableInstructionForm.java | 6 ++ .../unpack200/bytecode/forms/WideForm.java | 6 ++ .../commons/compress/utils/ByteUtils.java | 10 ++++ 39 files changed, 391 insertions(+), 5 deletions(-) diff --git a/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Constants.java b/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Constants.java index 74529d9063a..9350d2100e8 100644 --- a/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Constants.java +++ b/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Constants.java @@ -24,15 +24,54 @@ */ interface BZip2Constants { + /** + * Constant {@value}. + */ int BASEBLOCKSIZE = 100_000; + + /** + * Constant {@value}. + */ int MAX_ALPHA_SIZE = 258; + + /** + * Constant {@value}. + */ int MAX_CODE_LEN = 23; + + /** + * Constant {@value}. + */ int RUNA = 0; + + /** + * Constant {@value}. + */ int RUNB = 1; + + /** + * Constant {@value}. + */ int N_GROUPS = 6; + + /** + * Constant {@value}. + */ int G_SIZE = 50; + + /** + * Constant {@value}. + */ int N_ITERS = 4; + + /** + * Constant {@value}. + */ int MAX_SELECTORS = 2 + 900_000 / G_SIZE; + + /** + * Constant {@value}. + */ int NUM_OVERSHOOT_BYTES = 20; } diff --git a/src/main/java/org/apache/commons/compress/harmony/pack200/BandSet.java b/src/main/java/org/apache/commons/compress/harmony/pack200/BandSet.java index b4e7f7ec32d..c0ee1426add 100644 --- a/src/main/java/org/apache/commons/compress/harmony/pack200/BandSet.java +++ b/src/main/java/org/apache/commons/compress/harmony/pack200/BandSet.java @@ -84,7 +84,7 @@ public class BandData { private Map distinctValues; /** - * Constructs a new instance of BandData. The band is then analysed. + * Constructs a new instance of BandData. The band is then analyzed. * * @param band the band of integers */ diff --git a/src/main/java/org/apache/commons/compress/harmony/pack200/CanonicalCodecFamilies.java b/src/main/java/org/apache/commons/compress/harmony/pack200/CanonicalCodecFamilies.java index db2bcb6e702..55b9c027c38 100644 --- a/src/main/java/org/apache/commons/compress/harmony/pack200/CanonicalCodecFamilies.java +++ b/src/main/java/org/apache/commons/compress/harmony/pack200/CanonicalCodecFamilies.java @@ -26,6 +26,9 @@ public class CanonicalCodecFamilies { // Families of codecs for bands of positive integers that do not correlate // well (i.e. would not benefit from delta encoding) + /** + * Non-delta unsigned codecs 1. + */ public static BHSDCodec[] nonDeltaUnsignedCodecs1 = { // (1,256) is a special case and is considered separately so shouldn't be included here // CodecEncoding.getCanonicalCodec(1), // (1,256) @@ -34,6 +37,9 @@ public class CanonicalCodecFamilies { CodecEncoding.getCanonicalCodec(13) // (4,256) }; + /** + * Non-delta unsigned codecs 2. + */ public static BHSDCodec[] nonDeltaUnsignedCodecs2 = { CodecEncoding.getCanonicalCodec(17), // (5,4) CodecEncoding.getCanonicalCodec(20), // (5,16) CodecEncoding.getCanonicalCodec(23), // (5,32) @@ -41,6 +47,9 @@ public class CanonicalCodecFamilies { CodecEncoding.getCanonicalCodec(29) // (5,128) }; + /** + * Non-delta unsigned codecs 3. + */ public static BHSDCodec[] nonDeltaUnsignedCodecs3 = { CodecEncoding.getCanonicalCodec(47), // (2,192) CodecEncoding.getCanonicalCodec(48), // (2,224) CodecEncoding.getCanonicalCodec(49), // (2,240) @@ -48,6 +57,9 @@ public class CanonicalCodecFamilies { CodecEncoding.getCanonicalCodec(51) // (2,252) }; + /** + * Non-delta unsigned codecs 4. + */ public static BHSDCodec[] nonDeltaUnsignedCodecs4 = { CodecEncoding.getCanonicalCodec(70), // (3,192) CodecEncoding.getCanonicalCodec(71), // (3,224) CodecEncoding.getCanonicalCodec(72), // (3,240) @@ -55,6 +67,9 @@ public class CanonicalCodecFamilies { CodecEncoding.getCanonicalCodec(74) // (3,252) }; + /** + * Non-delta unsigned codecs 5. + */ public static BHSDCodec[] nonDeltaUnsignedCodecs5 = { CodecEncoding.getCanonicalCodec(93), // (4,192) CodecEncoding.getCanonicalCodec(94), // (4,224) CodecEncoding.getCanonicalCodec(95), // (4,240) @@ -65,12 +80,18 @@ public class CanonicalCodecFamilies { // Families of codecs for bands of positive integers that do correlate well // and would benefit from delta encoding + /** + * Delta unsigned codecs 1. + */ public static BHSDCodec[] deltaUnsignedCodecs1 = { CodecEncoding.getCanonicalCodec(3), // (1,256,0,1) CodecEncoding.getCanonicalCodec(7), // (2,256,0,1) CodecEncoding.getCanonicalCodec(11), // (3,256,0,1) CodecEncoding.getCanonicalCodec(15) // (4,256,0,1) }; + /** + * Delta unsigned codecs 2. + */ public static BHSDCodec[] deltaUnsignedCodecs2 = { CodecEncoding.getCanonicalCodec(32), // (5,4,0,1) CodecEncoding.getCanonicalCodec(35), // (5,16,0,1) CodecEncoding.getCanonicalCodec(38), // (5,32,0,1) @@ -78,6 +99,9 @@ public class CanonicalCodecFamilies { CodecEncoding.getCanonicalCodec(44) // (5,128,0,1) }; + /** + * Delta unsigned codecs 3. + */ public static BHSDCodec[] deltaUnsignedCodecs3 = { CodecEncoding.getCanonicalCodec(52), // (2,8,0,1) CodecEncoding.getCanonicalCodec(54), // (2,16,0,1) CodecEncoding.getCanonicalCodec(56), // (2,32,0,1) @@ -89,6 +113,9 @@ public class CanonicalCodecFamilies { CodecEncoding.getCanonicalCodec(68) // (2,248,0,1) }; + /** + * Delta unsigned codecs 4. + */ public static BHSDCodec[] deltaUnsignedCodecs4 = { CodecEncoding.getCanonicalCodec(75), // (3,8,0,1) CodecEncoding.getCanonicalCodec(77), // (3,16,0,1) CodecEncoding.getCanonicalCodec(79), // (3,32,0,1) @@ -100,6 +127,9 @@ public class CanonicalCodecFamilies { CodecEncoding.getCanonicalCodec(91) // (3,248,0,1) }; + /** + * Delta unsigned codecs 5. + */ public static BHSDCodec[] deltaUnsignedCodecs5 = { CodecEncoding.getCanonicalCodec(98), // (4,8,0,1) CodecEncoding.getCanonicalCodec(100), // (4,16,0,1) CodecEncoding.getCanonicalCodec(102), // (4,32,0,1) @@ -114,12 +144,18 @@ public class CanonicalCodecFamilies { // Families of codecs for bands containing positive and negative integers // that do correlate well (i.e. delta encoding is used) + /** + * Delta signed codecs 1. + */ public static BHSDCodec[] deltaSignedCodecs1 = { CodecEncoding.getCanonicalCodec(4), // (1,256,1,1) CodecEncoding.getCanonicalCodec(8), // (2,256,1,1) CodecEncoding.getCanonicalCodec(12), // (3,256,1,1) CodecEncoding.getCanonicalCodec(16) // (4,256,1,1) }; + /** + * Delta signed codecs 2. + */ public static BHSDCodec[] deltaSignedCodecs2 = { CodecEncoding.getCanonicalCodec(33), // (5,4,1,1) CodecEncoding.getCanonicalCodec(36), // (5,16,1,1) CodecEncoding.getCanonicalCodec(39), // (5,32,1,1) @@ -127,6 +163,9 @@ public class CanonicalCodecFamilies { CodecEncoding.getCanonicalCodec(45) // (5,128,1,1) }; + /** + * Delta signed codecs 3. + */ public static BHSDCodec[] deltaSignedCodecs3 = { CodecEncoding.getCanonicalCodec(53), // (2,8,1,1) CodecEncoding.getCanonicalCodec(55), // (2,16,1,1) CodecEncoding.getCanonicalCodec(57), // (2,32,1,1) @@ -138,6 +177,9 @@ public class CanonicalCodecFamilies { CodecEncoding.getCanonicalCodec(69) // (2,248,1,1) }; + /** + * Delta signed codecs 4. + */ public static BHSDCodec[] deltaSignedCodecs4 = { CodecEncoding.getCanonicalCodec(76), // (3,8,1,1) CodecEncoding.getCanonicalCodec(78), // (3,16,1,1) CodecEncoding.getCanonicalCodec(80), // (3,32,1,1) @@ -149,6 +191,9 @@ public class CanonicalCodecFamilies { CodecEncoding.getCanonicalCodec(92) // (3,248,1,1) }; + /** + * Delta signed codecs 5. + */ public static BHSDCodec[] deltaSignedCodecs5 = { CodecEncoding.getCanonicalCodec(99), // (4,8,1,1) CodecEncoding.getCanonicalCodec(101), // (4,16,1,1) CodecEncoding.getCanonicalCodec(103), // (4,32,1,1) @@ -160,6 +205,9 @@ public class CanonicalCodecFamilies { CodecEncoding.getCanonicalCodec(115) // (4,248,1,1) }; + /** + * Delta double signed codecs 1. + */ public static BHSDCodec[] deltaDoubleSignedCodecs1 = { CodecEncoding.getCanonicalCodec(34), // (5,4,2,1) CodecEncoding.getCanonicalCodec(37), // (5,16,2,1) CodecEncoding.getCanonicalCodec(40), // (5,32,2,1) @@ -170,12 +218,18 @@ public class CanonicalCodecFamilies { // Families of codecs for bands containing positive and negative values that // do not correlate well (i.e. delta encoding is not used) + /** + * Non-delta signed codecs 1. + */ public static BHSDCodec[] nonDeltaSignedCodecs1 = { CodecEncoding.getCanonicalCodec(2), // (1,256,1) CodecEncoding.getCanonicalCodec(6), // (2,256,1) CodecEncoding.getCanonicalCodec(10), // (3,256,1) CodecEncoding.getCanonicalCodec(14) // (4,256,1) }; + /** + * Non-delta signed codecs 2. + */ public static BHSDCodec[] nonDeltaSignedCodecs2 = { CodecEncoding.getCanonicalCodec(18), // (5,4,1) CodecEncoding.getCanonicalCodec(21), // (5,16,1) CodecEncoding.getCanonicalCodec(24), // (5,32,1) @@ -183,6 +237,9 @@ public class CanonicalCodecFamilies { CodecEncoding.getCanonicalCodec(30) // (5,128,1) }; + /** + * Non-delta double signed codecs 1. + */ public static BHSDCodec[] nonDeltaDoubleSignedCodecs1 = { CodecEncoding.getCanonicalCodec(19), // (5,4,2) CodecEncoding.getCanonicalCodec(22), // (5,16,2) CodecEncoding.getCanonicalCodec(25), // (5,32,2) diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ByteCodeForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ByteCodeForm.java index 8c2145849c4..c78a21cce42 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ByteCodeForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ByteCodeForm.java @@ -316,8 +316,8 @@ public static ByteCodeForm get(final int opcode) { /** * Constructs a new instance with the specified opcode and name. Assume no rewrite. * - * @param opcode int corresponding to the opcode's value. - * @param name String printable name of the opcode. + * @param opcode index corresponding to the opcode's value. + * @param name printable name of the opcode. */ public ByteCodeForm(final int opcode, final String name) { this(opcode, name, new int[] { opcode }); @@ -326,9 +326,9 @@ public ByteCodeForm(final int opcode, final String name) { /** * Constructs a new instance with the specified opcode, name, operandType and rewrite. * - * @param opcode int corresponding to the opcode's value. + * @param opcode index corresponding to the opcode's value. * @param name String printable name of the opcode. - * @param rewrite int[] Array of ints. Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. */ public ByteCodeForm(final int opcode, final String name, final int[] rewrite) { this.opcode = opcode; diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ByteForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ByteForm.java index 403a98fdbc8..cdf1e105f59 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ByteForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ByteForm.java @@ -26,6 +26,13 @@ */ public class ByteForm extends ByteCodeForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public ByteForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ClassRefForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ClassRefForm.java index 033632638be..4c452d508c3 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ClassRefForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ClassRefForm.java @@ -31,10 +31,25 @@ public class ClassRefForm extends ReferenceForm { protected boolean widened; + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public ClassRefForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + * @param widened TODO. + */ public ClassRefForm(final int opcode, final String name, final int[] rewrite, final boolean widened) { this(opcode, name, rewrite); this.widened = widened; diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ClassSpecificReferenceForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ClassSpecificReferenceForm.java index 529ef3ea205..557cd1316c4 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ClassSpecificReferenceForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ClassSpecificReferenceForm.java @@ -30,6 +30,13 @@ */ public abstract class ClassSpecificReferenceForm extends ReferenceForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public ClassSpecificReferenceForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/DoubleForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/DoubleForm.java index b07f4873e8b..5ea512c8cda 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/DoubleForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/DoubleForm.java @@ -26,6 +26,13 @@ */ public class DoubleForm extends ReferenceForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public DoubleForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/FieldRefForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/FieldRefForm.java index e27ea7f0d9f..1bd97afd0a0 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/FieldRefForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/FieldRefForm.java @@ -26,6 +26,13 @@ */ public class FieldRefForm extends ReferenceForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public FieldRefForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/FloatRefForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/FloatRefForm.java index 8a01771e5ed..ff092c95bc1 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/FloatRefForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/FloatRefForm.java @@ -26,10 +26,25 @@ */ public class FloatRefForm extends SingleByteReferenceForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public FloatRefForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + * @param widened TODO. + */ public FloatRefForm(final int opcode, final String name, final int[] rewrite, final boolean widened) { this(opcode, name, rewrite); this.widened = widened; diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/IMethodRefForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/IMethodRefForm.java index 6a81ef57ff0..4e47c48733a 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/IMethodRefForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/IMethodRefForm.java @@ -28,6 +28,13 @@ */ public class IMethodRefForm extends ReferenceForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public IMethodRefForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/IincForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/IincForm.java index d22b9b6f609..929b9a72381 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/IincForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/IincForm.java @@ -26,6 +26,13 @@ */ public class IincForm extends ByteCodeForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public IincForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/InitMethodReferenceForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/InitMethodReferenceForm.java index 4ae9f432a17..f05ac8fdc39 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/InitMethodReferenceForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/InitMethodReferenceForm.java @@ -29,6 +29,13 @@ */ public abstract class InitMethodReferenceForm extends ClassSpecificReferenceForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public InitMethodReferenceForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/IntRefForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/IntRefForm.java index 1b6a7a874aa..b0c8f79ea33 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/IntRefForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/IntRefForm.java @@ -26,10 +26,25 @@ */ public class IntRefForm extends SingleByteReferenceForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public IntRefForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + * @param widened TODO. + */ public IntRefForm(final int opcode, final String name, final int[] rewrite, final boolean widened) { this(opcode, name, rewrite); this.widened = widened; diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/LabelForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/LabelForm.java index 5254300a9c3..8f73ec0e0d8 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/LabelForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/LabelForm.java @@ -29,10 +29,25 @@ public class LabelForm extends ByteCodeForm { protected boolean widened; + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public LabelForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + * @param widened TODO. + */ public LabelForm(final int opcode, final String name, final int[] rewrite, final boolean widened) { this(opcode, name, rewrite); this.widened = widened; diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/LocalForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/LocalForm.java index 31a6fd2f9bf..12400df7002 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/LocalForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/LocalForm.java @@ -27,6 +27,13 @@ */ public class LocalForm extends ByteCodeForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public LocalForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/LongForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/LongForm.java index a3afe0f0709..92c9fe52cfd 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/LongForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/LongForm.java @@ -26,6 +26,13 @@ */ public class LongForm extends ReferenceForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public LongForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/LookupSwitchForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/LookupSwitchForm.java index 4b518e1e09f..eceace60c84 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/LookupSwitchForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/LookupSwitchForm.java @@ -25,6 +25,12 @@ public class LookupSwitchForm extends SwitchForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + */ public LookupSwitchForm(final int opcode, final String name) { super(opcode, name); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/MethodRefForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/MethodRefForm.java index 19fc125caef..152609110b6 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/MethodRefForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/MethodRefForm.java @@ -27,6 +27,13 @@ */ public class MethodRefForm extends ReferenceForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public MethodRefForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/MultiANewArrayForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/MultiANewArrayForm.java index 990d85c852c..d59a13f1a32 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/MultiANewArrayForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/MultiANewArrayForm.java @@ -28,6 +28,13 @@ */ public class MultiANewArrayForm extends ClassRefForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public MultiANewArrayForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/NarrowClassRefForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/NarrowClassRefForm.java index ed9659879c0..6d51856d75b 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/NarrowClassRefForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/NarrowClassRefForm.java @@ -27,10 +27,25 @@ */ public class NarrowClassRefForm extends ClassRefForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public NarrowClassRefForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + * @param widened TODO. + */ public NarrowClassRefForm(final int opcode, final String name, final int[] rewrite, final boolean widened) { super(opcode, name, rewrite, widened); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/NewClassRefForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/NewClassRefForm.java index 691646a94ca..8e1e4544aed 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/NewClassRefForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/NewClassRefForm.java @@ -31,6 +31,13 @@ */ public class NewClassRefForm extends ClassRefForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public NewClassRefForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/NewInitMethodRefForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/NewInitMethodRefForm.java index b8697f00816..cf025d90612 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/NewInitMethodRefForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/NewInitMethodRefForm.java @@ -29,6 +29,13 @@ */ public class NewInitMethodRefForm extends InitMethodReferenceForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public NewInitMethodRefForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/NoArgumentForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/NoArgumentForm.java index 52c67d4c82c..bc105c6bed4 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/NoArgumentForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/NoArgumentForm.java @@ -27,6 +27,12 @@ */ public class NoArgumentForm extends ByteCodeForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + */ public NoArgumentForm(final int opcode, final String name) { super(opcode, name); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ReferenceForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ReferenceForm.java index 8ca46927791..0cf63d8389f 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ReferenceForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ReferenceForm.java @@ -31,6 +31,13 @@ */ public abstract class ReferenceForm extends ByteCodeForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public ReferenceForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ShortForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ShortForm.java index a74f3a4c074..814688028c8 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ShortForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ShortForm.java @@ -26,6 +26,13 @@ */ public class ShortForm extends ByteCodeForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public ShortForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SingleByteReferenceForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SingleByteReferenceForm.java index dadea3947a3..412b97fef94 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SingleByteReferenceForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SingleByteReferenceForm.java @@ -29,6 +29,13 @@ public abstract class SingleByteReferenceForm extends ReferenceForm { protected boolean widened; + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public SingleByteReferenceForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/StringRefForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/StringRefForm.java index 840cd6bb808..d8682c5acaa 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/StringRefForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/StringRefForm.java @@ -29,10 +29,25 @@ */ public class StringRefForm extends SingleByteReferenceForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public StringRefForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + * @param widened TODO. + */ public StringRefForm(final int opcode, final String name, final int[] rewrite, final boolean widened) { this(opcode, name, rewrite); this.widened = widened; diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SuperFieldRefForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SuperFieldRefForm.java index a9c673afebb..845bc2c62b0 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SuperFieldRefForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SuperFieldRefForm.java @@ -27,6 +27,13 @@ */ public class SuperFieldRefForm extends ClassSpecificReferenceForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public SuperFieldRefForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SuperInitMethodRefForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SuperInitMethodRefForm.java index 71b677f4227..2a14f0f6e21 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SuperInitMethodRefForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SuperInitMethodRefForm.java @@ -23,6 +23,13 @@ */ public class SuperInitMethodRefForm extends InitMethodReferenceForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public SuperInitMethodRefForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SuperMethodRefForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SuperMethodRefForm.java index b667567b954..79b3feb6d4c 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SuperMethodRefForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SuperMethodRefForm.java @@ -27,6 +27,13 @@ */ public class SuperMethodRefForm extends ClassSpecificReferenceForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public SuperMethodRefForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SwitchForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SwitchForm.java index dcc6de2ffb8..ff3fe7f49de 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SwitchForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/SwitchForm.java @@ -23,6 +23,12 @@ public abstract class SwitchForm extends VariableInstructionForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + */ public SwitchForm(final int opcode, final String name) { super(opcode, name); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/TableSwitchForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/TableSwitchForm.java index a4fc0d90d43..7e227116012 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/TableSwitchForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/TableSwitchForm.java @@ -25,6 +25,12 @@ public class TableSwitchForm extends SwitchForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + */ public TableSwitchForm(final int opcode, final String name) { super(opcode, name); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ThisFieldRefForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ThisFieldRefForm.java index a6da781f416..90b8a611dc1 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ThisFieldRefForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ThisFieldRefForm.java @@ -27,6 +27,13 @@ */ public class ThisFieldRefForm extends ClassSpecificReferenceForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public ThisFieldRefForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ThisInitMethodRefForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ThisInitMethodRefForm.java index d676c41f72f..c3364775fad 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ThisInitMethodRefForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ThisInitMethodRefForm.java @@ -25,6 +25,13 @@ */ public class ThisInitMethodRefForm extends InitMethodReferenceForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public ThisInitMethodRefForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ThisMethodRefForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ThisMethodRefForm.java index a236e852a3e..714a4f7f969 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ThisMethodRefForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ThisMethodRefForm.java @@ -27,6 +27,13 @@ */ public class ThisMethodRefForm extends ClassSpecificReferenceForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1. + */ public ThisMethodRefForm(final int opcode, final String name, final int[] rewrite) { super(opcode, name, rewrite); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/VariableInstructionForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/VariableInstructionForm.java index 6b3ed2c7b25..cf0ee854873 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/VariableInstructionForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/VariableInstructionForm.java @@ -24,6 +24,12 @@ */ public abstract class VariableInstructionForm extends ByteCodeForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + */ public VariableInstructionForm(final int opcode, final String name) { super(opcode, name); } diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/WideForm.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/WideForm.java index 0281207a0b3..e748f8e8277 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/WideForm.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/WideForm.java @@ -26,6 +26,12 @@ */ public class WideForm extends VariableInstructionForm { + /** + * Constructs a new instance with the specified opcode, name, operandType and rewrite. + * + * @param opcode index corresponding to the opcode's value. + * @param name String printable name of the opcode. + */ public WideForm(final int opcode, final String name) { super(opcode, name); } diff --git a/src/main/java/org/apache/commons/compress/utils/ByteUtils.java b/src/main/java/org/apache/commons/compress/utils/ByteUtils.java index 32f97c715a9..32682bbca5c 100644 --- a/src/main/java/org/apache/commons/compress/utils/ByteUtils.java +++ b/src/main/java/org/apache/commons/compress/utils/ByteUtils.java @@ -72,6 +72,11 @@ public interface ByteSupplier { public static class InputStreamByteSupplier implements ByteSupplier { private final InputStream is; + /** + * Constructs a new instance. + * + * @param is an input stream. + */ public InputStreamByteSupplier(final InputStream is) { this.is = is; } @@ -90,6 +95,11 @@ public int getAsByte() throws IOException { public static class OutputStreamByteConsumer implements ByteConsumer { private final OutputStream os; + /** + * Constructs a new instance. + * + * @param os an output stream. + */ public OutputStreamByteConsumer(final OutputStream os) { this.os = os; }