Javadoc

Author: garydgregory

src/main/java/org/apache/commons/compress/harmony/internal/AttributeLayoutParser.java

@@ -125,6 +125,12 @@ private UnionCaseData(final List<IntegerRange> tagRanges, final List<T> body) {
     private int p;
     private int depth;
 
+    /**
+     * Constructs a new instance.
+     *
+     * @param definition the attribute layout definition.
+     * @param factory the factory for creating layout elements.
+     */
     public AttributeLayoutParser(final CharSequence definition, final Factory<T> factory) {
         this.definition = definition;
         this.factory = factory;

src/main/java/org/apache/commons/compress/harmony/pack200/AttributeDefinitionBands.java

@@ -35,13 +35,39 @@
  */
 public class AttributeDefinitionBands extends BandSet {
 
+    /**
+     * An attribute definition with context type, name, and layout information.
+     */
     public static class AttributeDefinition {
 
+        /**
+         * The index of this attribute definition.
+         */
         public int index;
+
+        /**
+         * The context type for this attribute definition.
+         */
         public int contextType;
+
+        /**
+         * The name of this attribute.
+         */
         public CPUTF8 name;
+
+        /**
+         * The layout of this attribute.
+         */
         public CPUTF8 layout;
 
+        /**
+         * Constructs a new AttributeDefinition.
+         *
+         * @param index the index of the attribute.
+         * @param contextType the context type.
+         * @param name the attribute name.
+         * @param layout the attribute layout.
+         */
         public AttributeDefinition(final int index, final int contextType, final CPUTF8 name, final CPUTF8 layout) {
             this.index = index;
             this.contextType = contextType;
@@ -82,6 +108,13 @@ public AttributeDefinition(final int index, final int contextType, final CPUTF8
 
     private final Segment segment;
 
+    /**
+     * Constructs a new instance.
+     *
+     * @param segment the segment.
+     * @param effort the effort level.
+     * @param attributePrototypes the attribute prototypes.
+     */
     public AttributeDefinitionBands(final Segment segment, final int effort, final Attribute[] attributePrototypes) {
         super(effort, segment.getSegmentHeader());
         this.cpBands = segment.getCpBands();
@@ -203,18 +236,38 @@ public void finaliseBands() {
         segmentHeader.setAttribute_definition_count(attributeDefinitions.size());
     }
 
+    /**
+     * Gets the class attribute layouts.
+     *
+     * @return the class attribute layouts.
+     */
     public List<AttributeDefinition> getClassAttributeLayouts() {
         return classAttributeLayouts;
     }
 
+    /**
+     * Gets the code attribute layouts.
+     *
+     * @return the code attribute layouts.
+     */
     public List<AttributeDefinition> getCodeAttributeLayouts() {
         return codeAttributeLayouts;
     }
 
+    /**
+     * Gets the field attribute layouts.
+     *
+     * @return the field attribute layouts.
+     */
     public List<AttributeDefinition> getFieldAttributeLayouts() {
         return fieldAttributeLayouts;
     }
 
+    /**
+     * Gets the method attribute layouts.
+     *
+     * @return the method attribute layouts.
+     */
     public List<AttributeDefinition> getMethodAttributeLayouts() {
         return methodAttributeLayouts;
     }

src/main/java/org/apache/commons/compress/harmony/pack200/BandSet.java

@@ -195,6 +195,9 @@ public boolean wellCorrelated() {
     // Note: these values have been tuned - please test carefully if changing them
     private static final int[] effortThresholds = { 0, 0, 1000, 500, 100, 100, 100, 100, 100, 0 };
 
+    /**
+     * The segment header for this band set.
+     */
     protected final SegmentHeader segmentHeader;
     final int effort;
 
@@ -486,6 +489,17 @@ protected byte[] encodeFlags(final String name, final long[] flags, final BHSDCo
 //        }
 //    }
 
+    /**
+     * Encodes flags using the given codecs.
+     *
+     * @param name the name of the band.
+     * @param flags the flags to encode.
+     * @param loCodec the low codec.
+     * @param hiCodec the high codec.
+     * @param haveHiFlags whether high flags are present.
+     * @return the encoded flags.
+     * @throws Pack200Exception if an error occurs.
+     */
     protected byte[] encodeFlags(final String name, final long[][] flags, final BHSDCodec loCodec, final BHSDCodec hiCodec, final boolean haveHiFlags)
             throws Pack200Exception {
         return encodeFlags(name, flatten(flags), loCodec, hiCodec, haveHiFlags);

src/main/java/org/apache/commons/compress/harmony/pack200/BcBands.java

@@ -85,6 +85,13 @@ public class BcBands extends BandSet {
     private int renumberedOffset;
     private final IntList bcLabelRelativeOffsets = new IntList();
 
+    /**
+     * Constructs a new instance.
+     *
+     * @param cpBands the constant pool bands
+     * @param segment the segment
+     * @param effort the packing effort
+     */
     public BcBands(final CpBands cpBands, final Segment segment, final int effort) {
         super(effort, segment.getSegmentHeader());
         this.cpBands = cpBands;
@@ -222,6 +229,9 @@ private void updateRenumbering() {
         bciRenumbering.add(renumberedOffset);
     }
 
+    /**
+     * Visits the end of a method's bytecode.
+     */
     public void visitEnd() {
         for (int i = 0; i < bciRenumbering.size(); i++) {
             if (bciRenumbering.get(i) == -1) {
@@ -254,6 +264,14 @@ public void visitEnd() {
         }
     }
 
+    /**
+     * Visits a field instruction.
+     *
+     * @param opcode the opcode.
+     * @param owner the field owner class.
+     * @param name the field name.
+     * @param desc the field descriptor.
+     */
     public void visitFieldInsn(int opcode, final String owner, final String name, final String desc) {
         byteCodeOffset += 3;
         updateRenumbering();
@@ -285,6 +303,12 @@ public void visitFieldInsn(int opcode, final String owner, final String name, fi
         bcCodes.add(opcode);
     }
 
+    /**
+     * Visits an IINC instruction.
+     *
+     * @param var the local variable index.
+     * @param increment the increment amount.
+     */
     public void visitIincInsn(final int var, final int increment) {
         if (var > 255 || increment > 255) {
             byteCodeOffset += 6;
@@ -301,6 +325,11 @@ public void visitIincInsn(final int var, final int increment) {
         updateRenumbering();
     }
 
+    /**
+     * Visits a simple instruction (no operands).
+     *
+     * @param opcode the opcode.
+     */
     public void visitInsn(final int opcode) {
         if (opcode >= 202) {
             throw new IllegalArgumentException("Non-standard bytecode instructions not supported");
@@ -310,6 +339,12 @@ public void visitInsn(final int opcode) {
         updateRenumbering();
     }
 
+    /**
+     * Visits an instruction with a single int operand.
+     *
+     * @param opcode the opcode.
+     * @param operand the operand.
+     */
     public void visitIntInsn(final int opcode, final int operand) {
         switch (opcode) {
         case 17: // sipush
@@ -326,6 +361,12 @@ public void visitIntInsn(final int opcode, final int operand) {
         updateRenumbering();
     }
 
+    /**
+     * Visits a jump instruction.
+     *
+     * @param opcode the opcode.
+     * @param label the target label.
+     */
     public void visitJumpInsn(final int opcode, final Label label) {
         bcCodes.add(opcode);
         bcLabel.add(label);
@@ -334,10 +375,20 @@ public void visitJumpInsn(final int opcode, final Label label) {
         updateRenumbering();
     }
 
+    /**
+     * Visits a label.
+     *
+     * @param label the label.
+     */
     public void visitLabel(final Label label) {
         labelsToOffsets.put(label, Integer.valueOf(byteCodeOffset));
     }
 
+    /**
+     * Visits an LDC instruction.
+     *
+     * @param cst the constant to load.
+     */
     public void visitLdcInsn(final Object cst) {
         final CPConstant<?> constant = cpBands.getConstant(cst);
         if (segment.lastConstantHadWideIndex() || constant instanceof CPLong || constant instanceof CPDouble) {
@@ -382,6 +433,13 @@ public void visitLdcInsn(final Object cst) {
         updateRenumbering();
     }
 
+    /**
+     * Visits a LOOKUPSWITCH instruction.
+     *
+     * @param dflt the default label.
+     * @param keys the case keys.
+     * @param labels the case labels.
+     */
     public void visitLookupSwitchInsn(final Label dflt, final int[] keys, final Label[] labels) {
         bcCodes.add(LOOKUPSWITCH);
         bcLabel.add(dflt);
@@ -397,6 +455,14 @@ public void visitLookupSwitchInsn(final Label dflt, final int[] keys, final Labe
         updateRenumbering();
     }
 
+    /**
+     * Visits a method invocation instruction.
+     *
+     * @param opcode the opcode.
+     * @param owner the method owner class.
+     * @param name the method name.
+     * @param desc the method descriptor.
+     */
     public void visitMethodInsn(int opcode, final String owner, final String name, final String desc) {
         byteCodeOffset += 3;
         switch (opcode) {
@@ -455,6 +521,12 @@ public void visitMethodInsn(int opcode, final String owner, final String name, f
         updateRenumbering();
     }
 
+    /**
+     * Visits a MULTIANEWARRAY instruction.
+     *
+     * @param desc the array type descriptor.
+     * @param dimensions the number of dimensions.
+     */
     public void visitMultiANewArrayInsn(final String desc, final int dimensions) {
         byteCodeOffset += 4;
         updateRenumbering();
@@ -463,6 +535,14 @@ public void visitMultiANewArrayInsn(final String desc, final int dimensions) {
         bcByte.add(dimensions & 0xFF);
     }
 
+    /**
+     * Visits a TABLESWITCH instruction.
+     *
+     * @param min the minimum key value.
+     * @param max the maximum key value.
+     * @param dflt the default label.
+     * @param labels the case labels.
+     */
     public void visitTableSwitchInsn(final int min, final int max, final Label dflt, final Label... labels) {
         bcCodes.add(TABLESWITCH);
         bcLabel.add(dflt);
@@ -479,6 +559,12 @@ public void visitTableSwitchInsn(final int min, final int max, final Label dflt,
         updateRenumbering();
     }
 
+    /**
+     * Visits a type instruction.
+     *
+     * @param opcode the opcode (NEW, ANEWARRAY, CHECKCAST, or INSTANCEOF).
+     * @param type the type descriptor.
+     */
     public void visitTypeInsn(final int opcode, final String type) {
         // NEW, ANEWARRAY, CHECKCAST or INSTANCEOF
         byteCodeOffset += 3;
@@ -490,6 +576,12 @@ public void visitTypeInsn(final int opcode, final String type) {
         }
     }
 
+    /**
+     * Visits a local variable instruction.
+     *
+     * @param opcode the opcode.
+     * @param var the local variable index.
+     */
     public void visitVarInsn(final int opcode, final int var) {
         // ILOAD, LLOAD, FLOAD, DLOAD, ALOAD, ISTORE, LSTORE, FSTORE, DSTORE, ASTORE or RET
         if (var > 255) {