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 6cb7da194 Javadoc
6cb7da194 is described below
commit 6cb7da194a9369edfbd65629576203b8af61ba44
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Sat Jul 26 08:55:07 2025 -0400
Javadoc
---
.../commons/compress/harmony/pack200/Archive.java | 2 +-
.../commons/compress/harmony/pack200/BandSet.java | 28 +++++++++++-----------
.../commons/compress/harmony/pack200/Codec.java | 22 ++++++++---------
.../commons/compress/harmony/pack200/Segment.java | 6 ++---
.../compress/harmony/unpack200/ClassBands.java | 2 +-
.../harmony/unpack200/NewAttributeBands.java | 2 +-
.../apache/commons/compress/utils/TimeUtils.java | 4 ----
7 files changed, 31 insertions(+), 35 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java
index 86c4ca77f..3c86806e4 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java
@@ -271,7 +271,7 @@ private long estimateSize(final PackingFile packingFile) {
/**
* Packs the archive.
*
- * @throws Pack200Exception TODO
+ * @throws Pack200Exception If a Pack200 semantic error occurs.
* @throws IOException If an I/O error occurs.
*/
public void pack() throws Pack200Exception, IOException {
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 e3f0bb664..28d110c32 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
@@ -353,7 +353,7 @@ protected int[] cpEntryOrNullListToArray(final List<?
extends ConstantPoolEntry>
* @param ints the band
* @param defaultCodec the default Codec
* @return the encoded band
- * @throws Pack200Exception TODO
+ * @throws Pack200Exception If a Pack200 semantic error occurs.
*/
public byte[] encodeBandInt(final String name, final int[] ints, final
BHSDCodec defaultCodec) throws Pack200Exception {
byte[] encodedBand = null;
@@ -433,7 +433,7 @@ public byte[] encodeBandInt(final String name, final int[]
ints, final BHSDCodec
* @param hiCodec Codec for the high 32-bits band
* @param haveHiFlags ignores the high band if true as all values would be
zero
* @return the encoded band
- * @throws Pack200Exception TODO
+ * @throws Pack200Exception If a Pack200 semantic error occurs.
*/
protected byte[] encodeFlags(final String name, final long[] flags, final
BHSDCodec loCodec, final BHSDCodec hiCodec, final boolean haveHiFlags)
throws Pack200Exception {
@@ -490,24 +490,24 @@ protected byte[] encodeFlags(final String name, final
long[][] flags, final BHSD
}
/**
- * Encode a single value with the given Codec
+ * Encodes a single value with the given Codec.
*
- * @param value the value to encode
- * @param codec Codec to use
- * @return the encoded value
- * @throws Pack200Exception TODO
+ * @param value the value to encode.
+ * @param codec Codec to use.
+ * @return the encoded value.
+ * @throws Pack200Exception If a Pack200 semantic error occurs.
*/
public byte[] encodeScalar(final int value, final BHSDCodec codec) throws
Pack200Exception {
return codec.encode(value);
}
/**
- * Encode a band without considering other Codecs
+ * Encode a band without considering other Codecs.
*
- * @param band the band
- * @param codec the Codec to use
- * @return the encoded band
- * @throws Pack200Exception TODO
+ * @param band the band.
+ * @param codec the Codec to use.
+ * @return the encoded band.
+ * @throws Pack200Exception If a Pack200 semantic error occurs.
*/
public byte[] encodeScalar(final int[] band, final BHSDCodec codec) throws
Pack200Exception {
return codec.encode(band);
@@ -706,11 +706,11 @@ protected long[] longListToArray(final List<Long>
longList) {
}
/**
- * Writes the packed set of bands to the given output stream
+ * Writes the packed set of bands to the given output stream.
*
* @param out TODO
* @throws IOException If an I/O error occurs.
- * @throws Pack200Exception TODO
+ * @throws Pack200Exception If a Pack200 semantic error occurs.
*/
public abstract void pack(OutputStream out) throws IOException,
Pack200Exception;
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/Codec.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/Codec.java
index 4326e25b1..e43000842 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/Codec.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/Codec.java
@@ -174,28 +174,28 @@ public int[] decodeInts(final int n, final InputStream
in, final int firstValue)
/**
* Encodes a single value into a sequence of bytes. Note that this method
can only be used for non-delta encodings.
*
- * @param value the value to encode
- * @return the encoded bytes
- * @throws Pack200Exception TODO
+ * @param value the value to encode.
+ * @return the encoded bytes.
+ * @throws Pack200Exception If a Pack200 semantic error occurs.
*/
public abstract byte[] encode(int value) throws Pack200Exception;
/**
* Encodes a single value into a sequence of bytes.
*
- * @param value the value to encode
- * @param last the previous value encoded (for delta encodings)
- * @return the encoded bytes
- * @throws Pack200Exception TODO
+ * @param value the value to encode.
+ * @param last the previous value encoded (for delta encodings).
+ * @return the encoded bytes.
+ * @throws Pack200Exception If a Pack200 semantic error occurs.
*/
public abstract byte[] encode(int value, int last) throws Pack200Exception;
/**
- * Encodes a sequence of integers into a byte array
+ * Encodes a sequence of integers into a byte array.
*
- * @param ints the values to encode
- * @return byte[] encoded bytes
- * @throws Pack200Exception if there is a problem encoding any of the
values
+ * @param ints the values to encode.
+ * @return byte[] encoded bytes.
+ * @throws Pack200Exception if there is a problem encoding any of the
values.
*/
public byte[] encode(final int[] ints) throws Pack200Exception {
int total = 0;
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/Segment.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/Segment.java
index cd97e3270..095745beb 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/Segment.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/Segment.java
@@ -562,10 +562,10 @@ public boolean lastConstantHadWideIndex() {
* The main method on Segment. Reads in all the class files, packs them
and then writes the packed segment out to the given OutputStream.
*
* @param segmentUnit TODO
- * @param out the OutputStream to write the packed Segment to
- * @param options packing options
+ * @param out the OutputStream to write the packed Segment to.
+ * @param options packing options.
* @throws IOException If an I/O error occurs.
- * @throws Pack200Exception TODO
+ * @throws Pack200Exception If a Pack200 semantic error occurs.
*/
public void pack(final SegmentUnit segmentUnit, final OutputStream out,
final PackingOptions options) throws IOException, Pack200Exception {
this.options = options;
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/ClassBands.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/ClassBands.java
index 3ac63c131..f9fdc3890 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/ClassBands.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/ClassBands.java
@@ -533,7 +533,7 @@ private void parseClassAttrBands(final InputStream in)
throws IOException, Pack2
* @param in TODO
* @param classAttrCalls TODO
* @return the number of backwards callables.
- * @throws Pack200Exception TODO
+ * @throws Pack200Exception If a Pack200 semantic error occurs.
* @throws IOException If an I/O error occurs.
*/
private int parseClassMetadataBands(final InputStream in, final int[]
classAttrCalls) throws Pack200Exception, IOException {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/NewAttributeBands.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/NewAttributeBands.java
index ff6c44ba1..eda94bd74 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/NewAttributeBands.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/NewAttributeBands.java
@@ -686,7 +686,7 @@ private StringReader getStreamUpToMatchingBracket(final
StringReader stream) thr
* @param occurrenceCount TODO
* @return Class file attributes as a List of {@link Attribute}.
* @throws IOException If an I/O error occurs.
- * @throws Pack200Exception TODO
+ * @throws Pack200Exception If a Pack200 semantic error occurs.
*/
public List<Attribute> parseAttributes(final InputStream in, final int
occurrenceCount) throws IOException, Pack200Exception {
for (final AttributeLayoutElement element : attributeLayoutElements) {
diff --git a/src/main/java/org/apache/commons/compress/utils/TimeUtils.java
b/src/main/java/org/apache/commons/compress/utils/TimeUtils.java
index 65a5a3236..3611603f5 100644
--- a/src/main/java/org/apache/commons/compress/utils/TimeUtils.java
+++ b/src/main/java/org/apache/commons/compress/utils/TimeUtils.java
@@ -59,10 +59,6 @@ public final class TimeUtils {
/**
* Tests whether a FileTime can be safely represented in the standard Unix
time.
*
- * <p>
- * TODO ? If the FileTime is null, this method always returns true.
- * </p>
- *
* @param time the FileTime to evaluate, can be null.
* @return true if the time exceeds the minimum or maximum Unix time,
false otherwise.
* @deprecated use {@link FileTimes#isUnixTime(FileTime)}
