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 1cca1110fcdeb02730084ea801c3d8f8fc3121d1
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Oct 19 08:29:44 2023 -0400
Add GzipParameters.setFileName(String) and deprecate setFilename(String)
---
src/changes/changes.xml | 3 ++-
.../compress/compressors/gzip/GzipCompressorInputStream.java | 2 +-
.../commons/compress/compressors/gzip/GzipParameters.java | 11 +++++++++++
.../org/apache/commons/compress/compressors/GZipTestCase.java | 9 +++++++++
.../compressors/gzip/GzipCompressorOutputStreamTest.java | 3 +++
5 files changed, 26 insertions(+), 2 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 2f08461b..ada37ee8 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -46,7 +46,8 @@ The <action> type attribute can be add,update,fix,remove.
<body>
<release version="1.25.0" date="202Y-MM-DD" description="Minor feature and
maintenance release.">
<!-- ADD -->
- <action type="add" dev="ggregory" due-to="Gary Gregory">Add
GzipParameters.getFileName() and deprecated getFilename().</action>
+ <action type="add" dev="ggregory" due-to="Gary Gregory">Add
GzipParameters.getFileName() and deprecate getFilename().</action>
+ <action type="add" dev="ggregory" due-to="Gary Gregory">Add
GzipParameters.setFileName(String) and deprecate setFilename(String).</action>
<!-- FIX -->
<!-- UPDATE -->
<action type="update" dev="ggregory" due-to="Dependabot">Bump
org.slf4j:slf4j-api from 2.0.8 to 2.0.9 #413.</action>
diff --git
a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
index 2e41e771..253bac21 100644
---
a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
@@ -285,7 +285,7 @@ public class GzipCompressorInputStream extends
CompressorInputStream
// Original file name
if ((flg & FNAME) != 0) {
- parameters.setFilename(new String(readToNull(inData),
GzipUtils.GZIP_ENCODING));
+ parameters.setFileName(new String(readToNull(inData),
GzipUtils.GZIP_ENCODING));
}
// Comment
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 9530b8ba..51d25684 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
@@ -147,11 +147,22 @@ public class GzipParameters {
* Sets the name of the compressed file.
*
* @param fileName the name of the file without the directory path
+ * @deprecated Use {@link #setFileName(String)}.
*/
+ @Deprecated
public void setFilename(final String fileName) {
this.fileName = fileName;
}
+ /**
+ * Sets the name of the compressed file.
+ *
+ * @param fileName the name of the file without the directory path
+ */
+ public void setFileName(final String fileName) {
+ this.fileName = fileName;
+ }
+
/**
* Sets the modification time of the compressed file.
*
diff --git
a/src/test/java/org/apache/commons/compress/compressors/GZipTestCase.java
b/src/test/java/org/apache/commons/compress/compressors/GZipTestCase.java
index 2b1cbad7..21527a9f 100644
--- a/src/test/java/org/apache/commons/compress/compressors/GZipTestCase.java
+++ b/src/test/java/org/apache/commons/compress/compressors/GZipTestCase.java
@@ -170,6 +170,9 @@ public final class GZipTestCase extends AbstractTestCase {
parameters.setCompressionLevel(Deflater.BEST_COMPRESSION);
parameters.setOperatingSystem(3);
parameters.setFilename("test3.xml");
+ assertEquals(parameters.getFilename(), parameters.getFileName());
+ parameters.setFileName("test3.xml");
+ assertEquals(parameters.getFilename(), parameters.getFileName());
parameters.setComment("Test file");
parameters.setModificationTime(System.currentTimeMillis());
try (GzipCompressorOutputStream out = new
GzipCompressorOutputStream(bout, parameters)) {
@@ -196,6 +199,9 @@ public final class GZipTestCase extends AbstractTestCase {
parameters.setCompressionLevel(Deflater.BEST_COMPRESSION);
parameters.setOperatingSystem(3);
parameters.setFilename("test3.xml");
+ assertEquals(parameters.getFilename(), parameters.getFileName());
+ parameters.setFileName("test3.xml");
+ assertEquals(parameters.getFilename(), parameters.getFileName());
parameters.setComment("Test file");
parameters.setModificationTime(System.currentTimeMillis());
try (GzipCompressorOutputStream out = new
GzipCompressorOutputStream(bout, parameters)) {
@@ -234,6 +240,9 @@ public final class GZipTestCase extends AbstractTestCase {
parameters.setModificationTime(123456000);
parameters.setOperatingSystem(13);
parameters.setFilename("test3.xml");
+ assertEquals(parameters.getFilename(), parameters.getFileName());
+ parameters.setFileName("test3.xml");
+ assertEquals(parameters.getFilename(), parameters.getFileName());
parameters.setComment("Umlaute möglich?");
try (GzipCompressorOutputStream out = new
GzipCompressorOutputStream(bout, parameters)) {
Files.copy(getFile("test3" + ".xml").toPath(), out);
diff --git
a/src/test/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStreamTest.java
b/src/test/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStreamTest.java
index 4dee3c84..2c1c5f26 100644
---
a/src/test/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStreamTest.java
+++
b/src/test/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStreamTest.java
@@ -40,6 +40,9 @@ public class GzipCompressorOutputStreamTest {
final Path targetFile = Files.createTempFile("test", ".gz");
final GzipParameters parameters = new GzipParameters();
parameters.setFilename(sourceFile);
+ assertEquals(parameters.getFilename(), parameters.getFileName());
+ parameters.setFileName(sourceFile);
+ assertEquals(parameters.getFilename(), parameters.getFileName());
try (OutputStream fos = Files.newOutputStream(targetFile);
GzipCompressorOutputStream gos = new GzipCompressorOutputStream(fos,
parameters)) {
Files.copy(tempSourceFile, gos);
}
