This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-compress.git
The following commit(s) were added to refs/heads/master by this push:
new 4e31ac7a9 Javadoc
4e31ac7a9 is described below
commit 4e31ac7a95115fdd0b6cf81744baac53cdbfa26c
Author: Gary D. Gregory <[email protected]>
AuthorDate: Mon Mar 17 19:44:41 2025 -0400
Javadoc
---
.../commons/compress/harmony/pack200/BcBands.java | 4 ++--
.../commons/compress/harmony/pack200/CPClass.java | 15 ++++++++++-----
.../commons/compress/harmony/pack200/CPDouble.java | 15 ++++++++++-----
.../commons/compress/harmony/pack200/CPFloat.java | 15 ++++++++++-----
.../apache/commons/compress/harmony/pack200/CPInt.java | 15 ++++++++++-----
.../apache/commons/compress/harmony/pack200/CPLong.java | 17 +++++++++++------
.../commons/compress/harmony/pack200/CPString.java | 15 ++++++++++-----
.../compress/harmony/pack200/ConstantPoolEntry.java | 12 +++++++++++-
8 files changed, 74 insertions(+), 34 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/BcBands.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/BcBands.java
index 5ebd68741..3b92f6779 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/BcBands.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/BcBands.java
@@ -53,7 +53,7 @@ public class BcBands extends BandSet {
private final IntList bcShort = new IntList();
private final IntList bcLocal = new IntList();
- // Integers and Labels
+ // This List holds Integers and Labels
private final List bcLabel = new ArrayList();
private final List<CPInt> bcIntref = new ArrayList<>();
private final List<CPFloat> bcFloatRef = new ArrayList<>();
@@ -66,7 +66,7 @@ public class BcBands extends BandSet {
private final List<CPMethodOrField> bcMethodRef = new ArrayList<>();
private final List<CPMethodOrField> bcIMethodRef = new ArrayList<>();
- // Integers and CPMethodOrField
+ // This List holds Integers and CPMethodOrField
private List bcThisField = new ArrayList<>();
private final List bcSuperField = new ArrayList<>();
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/CPClass.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/CPClass.java
index eb12fafe3..e28ff8d03 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/CPClass.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/CPClass.java
@@ -24,12 +24,17 @@
public class CPClass extends CPConstant<CPClass> {
private final String className;
- private final CPUTF8 utf8;
+ private final CPUTF8 value;
private final boolean isInnerClass;
- public CPClass(final CPUTF8 utf8) {
- this.utf8 = utf8;
- this.className = utf8.getUnderlyingString();
+ /**
+ * Constructs a new instance.
+ *
+ * @param value The value.
+ */
+ public CPClass(final CPUTF8 value) {
+ this.value = value;
+ this.className = value.getUnderlyingString();
final char[] chars = className.toCharArray();
for (final char element : chars) {
if (element <= 0x2D) {
@@ -46,7 +51,7 @@ public int compareTo(final CPClass arg0) {
}
public int getIndexInCpUtf8() {
- return utf8.getIndex();
+ return value.getIndex();
}
public boolean isInnerClass() {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/CPDouble.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/CPDouble.java
index 6e6addf82..671a60c9a 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/CPDouble.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/CPDouble.java
@@ -23,18 +23,23 @@
*/
public class CPDouble extends CPConstant<CPDouble> {
- private final double theDouble;
+ private final double value;
- public CPDouble(final double theDouble) {
- this.theDouble = theDouble;
+ /**
+ * Constructs a new instance.
+ *
+ * @param value The value.
+ */
+ public CPDouble(final double value) {
+ this.value = value;
}
@Override
public int compareTo(final CPDouble obj) {
- return Double.compare(theDouble, obj.theDouble);
+ return Double.compare(value, obj.value);
}
public double getDouble() {
- return theDouble;
+ return value;
}
}
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/CPFloat.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/CPFloat.java
index 00bb6125b..8a1fef0ee 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/CPFloat.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/CPFloat.java
@@ -23,18 +23,23 @@
*/
public class CPFloat extends CPConstant<CPFloat> {
- private final float theFloat;
+ private final float value;
- public CPFloat(final float theFloat) {
- this.theFloat = theFloat;
+ /**
+ * Constructs a new instance.
+ *
+ * @param value The value.
+ */
+ public CPFloat(final float value) {
+ this.value = value;
}
@Override
public int compareTo(final CPFloat obj) {
- return Float.compare(theFloat, obj.theFloat);
+ return Float.compare(value, obj.value);
}
public float getFloat() {
- return theFloat;
+ return value;
}
}
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/CPInt.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/CPInt.java
index 9c9d692a7..e6c752ba5 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/CPInt.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/CPInt.java
@@ -23,18 +23,23 @@
*/
public class CPInt extends CPConstant<CPInt> {
- private final int theInt;
+ private final int value;
- public CPInt(final int theInt) {
- this.theInt = theInt;
+ /**
+ * Constructs a new instance.
+ *
+ * @param value The value.
+ */
+ public CPInt(final int value) {
+ this.value = value;
}
@Override
public int compareTo(final CPInt obj) {
- return Integer.compare(theInt, obj.theInt);
+ return Integer.compare(value, obj.value);
}
public int getInt() {
- return theInt;
+ return value;
}
}
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/CPLong.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/CPLong.java
index fe5d74e49..8257deb5f 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/CPLong.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/CPLong.java
@@ -23,24 +23,29 @@
*/
public class CPLong extends CPConstant<CPLong> {
- private final long theLong;
+ private final long value;
- public CPLong(final long theLong) {
- this.theLong = theLong;
+ /**
+ * Constructs a new instance.
+ *
+ * @param value The value.
+ */
+ public CPLong(final long value) {
+ this.value = value;
}
@Override
public int compareTo(final CPLong obj) {
- return Long.compare(theLong, obj.theLong);
+ return Long.compare(value, obj.value);
}
public long getLong() {
- return theLong;
+ return value;
}
@Override
public String toString() {
- return "" + theLong;
+ return "" + value;
}
}
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/CPString.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/CPString.java
index c161eb19c..919d85565 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/CPString.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/CPString.java
@@ -24,11 +24,16 @@
public class CPString extends CPConstant<CPString> {
private final String string;
- private final CPUTF8 utf8;
+ private final CPUTF8 value;
- public CPString(final CPUTF8 utf8) {
- this.utf8 = utf8;
- this.string = utf8.getUnderlyingString();
+ /**
+ * Constructs a new instance.
+ *
+ * @param value The value.
+ */
+ public CPString(final CPUTF8 value) {
+ this.value = value;
+ this.string = value.getUnderlyingString();
}
@Override
@@ -37,7 +42,7 @@ public int compareTo(final CPString arg0) {
}
public int getIndexInCpUtf8() {
- return utf8.getIndex();
+ return value.getIndex();
}
@Override
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/ConstantPoolEntry.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/ConstantPoolEntry.java
index d771449f8..ee3ca3975 100644
---
a/src/main/java/org/apache/commons/compress/harmony/pack200/ConstantPoolEntry.java
+++
b/src/main/java/org/apache/commons/compress/harmony/pack200/ConstantPoolEntry.java
@@ -16,6 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
+
package org.apache.commons.compress.harmony.pack200;
/**
@@ -25,12 +26,21 @@ public abstract class ConstantPoolEntry {
private int index = -1;
+ /**
+ * Gets the index.
+ *
+ * @return the index.
+ */
public int getIndex() {
return index;
}
+ /**
+ * Sets the index.
+ *
+ * @param index the index.
+ */
public void setIndex(final int index) {
this.index = index;
}
-
}
