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 f8ef32abb Add missing Javadoc
f8ef32abb is described below
commit f8ef32abb126cf752e8ccccc7eb5b574a70f1180
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Nov 6 08:11:42 2024 -0500
Add missing Javadoc
---
.../compress/compressors/gzip/GzipParameters.java | 27 +++++++++++++++++++++-
1 file changed, 26 insertions(+), 1 deletion(-)
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 3da86c541..c5c417d5d 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
@@ -33,6 +33,15 @@ import java.util.zip.Deflater;
public class GzipParameters {
private int compressionLevel = Deflater.DEFAULT_COMPRESSION;
+
+ /**
+ * The most recent modification time (MTIME) of the original file being
compressed.
+ * <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>
+ */
private long modificationTime;
private String fileName;
private String comment;
@@ -92,6 +101,17 @@ public class GzipParameters {
return fileName;
}
+
+ /**
+ * Gets the most recent modification time (MTIME) of the original file
being compressed.
+ * <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.
+ */
public long getModificationTime() {
return modificationTime;
}
@@ -165,7 +185,12 @@ public class GzipParameters {
}
/**
- * Sets the modification time of the compressed file.
+ * Sets the modification time (MTIME) of the compressed file.
+ * <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
*/
