(commons-compress) 02/04: Fix Javadoc

[ggregory]

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

commit 83faff73459d9af4696aec3842e51737f4b61e57
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Nov 6 11:21:06 2024 -0500

    Fix Javadoc
    
    Switch internal representation from long to Instant
---
 .../compress/compressors/gzip/GzipParameters.java      | 18 +++++++++---------
 .../apache/commons/compress/compressors/GZipTest.java  |  9 +++++----
 2 files changed, 14 insertions(+), 13 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipParameters.java
 
b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipParameters.java
index f1d4fa8bf..6338a70e9 100644
--- 
a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipParameters.java
+++ 
b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipParameters.java
@@ -285,7 +285,7 @@ public class GzipParameters {
      * means no time stamp is available.
      * </p>
      */
-    private long modificationTime;
+    private Instant modificationTime = Instant.EPOCH;
     private String fileName;
     private String comment;
     private OS operatingSystem = OS.UNKNOWN; // Unknown OS by default
@@ -352,21 +352,21 @@ public class GzipParameters {
      * @since 1.28.0
      */
     public Instant getModificationInstant() {
-        return Instant.ofEpochSecond(modificationTime);
+        return modificationTime;
     }
 
     /**
-     * Gets the most recent modification time (MTIME) of the original file 
being compressed.
+     * Gets the most recent modification time (MTIME) of the original file 
being compressed, in seconds since 00:00:00 GMT, Jan. 1, 1970.
      * <p>
      * The time is in Unix format, for example, seconds since 00:00:00 GMT, 
Jan. 1, 1970. (Note that this may cause problems for MS-DOS and other systems 
that
      * use local rather than Universal time.) If the compressed data did not 
come from a file, MTIME is set to the time at which compression started. MTIME 
= 0
      * means no time stamp is available.
      * </p>
      *
-     * @return the most recent modification time.
+     * @return the most recent modification time in seconds since 00:00:00 
GMT, Jan. 1, 1970.
      */
     public long getModificationTime() {
-        return modificationTime;
+        return modificationTime.getEpochSecond();
     }
 
     /**
@@ -459,21 +459,21 @@ public class GzipParameters {
      * @since 1.28.0
      */
     public void setModificationInstant(final Instant modificationTime) {
-        this.modificationTime = modificationTime != null ? 
modificationTime.getEpochSecond() : 0;
+        this.modificationTime = modificationTime != null ? modificationTime : 
Instant.EPOCH;
     }
 
     /**
-     * Sets the modification time (MTIME) of the compressed file.
+     * Sets the modification time (MTIME) of the compressed file, in seconds 
since 00:00:00 GMT, Jan. 1, 1970.
      * <p>
      * The time is in Unix format, for example, seconds since 00:00:00 GMT, 
Jan. 1, 1970. (Note that this may cause problems for MS-DOS and other systems 
that
      * use local rather than Universal time.) If the compressed data did not 
come from a file, MTIME is set to the time at which compression started. MTIME 
= 0
      * means no time stamp is available.
      * </p>
      *
-     * @param modificationTime the modification time, in milliseconds
+     * @param modificationTime the modification time, in seconds.
      */
     public void setModificationTime(final long modificationTime) {
-        this.modificationTime = modificationTime;
+        this.modificationTime = Instant.ofEpochSecond(modificationTime);
     }
 
     /**
diff --git 
a/src/test/java/org/apache/commons/compress/compressors/GZipTest.java 
b/src/test/java/org/apache/commons/compress/compressors/GZipTest.java
index 5d8ccbea5..d3492e08e 100644
--- a/src/test/java/org/apache/commons/compress/compressors/GZipTest.java
+++ b/src/test/java/org/apache/commons/compress/compressors/GZipTest.java
@@ -44,7 +44,8 @@ import org.junit.jupiter.params.provider.ValueSource;
 
 public final class GZipTest extends AbstractTest {
 
-    private static final Instant MTIME = Instant.ofEpochSecond(123456000);
+    private static final int MTIME = 123456000;
+    private static final Instant MTIME_INSTANT = Instant.ofEpochSecond(MTIME);
 
     @Test
     public void testConcatenatedStreamsReadFirstOnly() throws Exception {
@@ -204,9 +205,9 @@ public final class GZipTest extends AbstractTest {
         assertEquals(0, parameters.getModificationTime());
         parameters.setModificationInstant(null);
         assertEquals(0, parameters.getModificationTime());
-        parameters.setModificationInstant(MTIME);
-        assertEquals(MTIME.getEpochSecond(), parameters.getModificationTime());
-        assertEquals(MTIME, parameters.getModificationInstant());
+        parameters.setModificationInstant(MTIME_INSTANT);
+        assertEquals(MTIME_INSTANT.getEpochSecond(), 
parameters.getModificationTime());
+        assertEquals(MTIME_INSTANT, parameters.getModificationInstant());
         parameters.setOS(GzipParameters.OS.Z_SYSTEM);
         assertEquals(GzipParameters.OS.Z_SYSTEM, parameters.getOS());
         parameters.setOS(null);