(commons-compress) 03/04: Add GzipParameters.toString()

[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 9f9b3d1238c53ff56f8b90c7de6b6459765ee14c
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Nov 6 11:35:32 2024 -0500

    Add GzipParameters.toString()
---
 src/changes/changes.xml                                          | 1 +
 .../apache/commons/compress/compressors/gzip/GzipParameters.java | 9 +++++++++
 .../commons/compress/compressors/gzip/GzipParametersTest.java    | 9 +++++++++
 3 files changed, 19 insertions(+)

diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 089fdadbf..373f38e3d 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -52,6 +52,7 @@ The <action> type attribute can be add,update,fix,remove.
       <action type="add" dev="ggregory" due-to="Gary Gregory">Add 
GzipParameters.getModificationInstant().</action>
       <action type="add" dev="ggregory" due-to="Gary Gregory">Add 
GzipParameters.setModificationInstant(Instant).</action>
       <action type="add" dev="ggregory" due-to="Gary Gregory">Add 
GzipParameters.OS, setOS(OS), getOS().</action>
+      <action type="add" dev="ggregory" due-to="Gary Gregory">Add 
GzipParameters.toString().</action>
       <!-- UPDATE -->
       <action type="update" dev="ggregory" due-to="Dependabot, Gary 
Gregory">Bump org.apache.commons:commons-parent from 72 to 78 #563, #567, #574, 
#582, #587, #595.</action>
       <action type="update" dev="ggregory" due-to="Dependabot, Gary 
Gregory">Bump com.github.luben:zstd-jni from 1.5.6-4 to 1.5.6-7 #565, #578, 
#601.</action>
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 6338a70e9..51ff061e5 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
@@ -511,4 +511,13 @@ public class GzipParameters {
     public void setOS(final OS os) {
         this.operatingSystem = os != null ? os : OS.UNKNOWN;
     }
+
+    @Override
+    public String toString() {
+        StringBuilder builder = new StringBuilder();
+        builder.append("GzipParameters 
[compressionLevel=").append(compressionLevel).append(", 
modificationTime=").append(modificationTime)
+                .append(", fileName=").append(fileName).append(", 
comment=").append(comment).append(", operatingSystem=").append(operatingSystem)
+                .append(", bufferSize=").append(bufferSize).append(", 
deflateStrategy=").append(deflateStrategy).append("]");
+        return builder.toString();
+    }
 }
diff --git 
a/src/test/java/org/apache/commons/compress/compressors/gzip/GzipParametersTest.java
 
b/src/test/java/org/apache/commons/compress/compressors/gzip/GzipParametersTest.java
index 866bc3d8d..30f1b09a9 100644
--- 
a/src/test/java/org/apache/commons/compress/compressors/gzip/GzipParametersTest.java
+++ 
b/src/test/java/org/apache/commons/compress/compressors/gzip/GzipParametersTest.java
@@ -20,6 +20,7 @@
 package org.apache.commons.compress.compressors.gzip;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import java.util.zip.Deflater;
 
@@ -37,4 +38,12 @@ public class GzipParametersTest {
         gzipParameters.setDeflateStrategy(Deflater.HUFFMAN_ONLY);
         assertEquals(Deflater.HUFFMAN_ONLY, 
gzipParameters.getDeflateStrategy());
     }
+
+    @Test
+    public void testToString() {
+        final GzipParameters gzipParameters = new GzipParameters();
+        assertTrue(gzipParameters.toString().contains("UNKNOWN"));
+        gzipParameters.setOS(GzipParameters.OS.Z_SYSTEM);
+        assertTrue(gzipParameters.toString().contains("Z_SYSTEM"));
+    }
 }