You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/11/12 14:32:19 UTC

(commons-compress) 01/03: Rename internal constant

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 efd133fb1c3f195030e9c8c61f7e5e86adfa3fcb
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Nov 12 09:26:39 2023 -0500

    Rename internal constant
---
 .../compress/archivers/tar/TarArchiveOutputStream.java    |  5 +++--
 .../compress/archivers/zip/ZipArchiveInputStream.java     |  2 +-
 .../compress/archivers/zip/ZipArchiveOutputStream.java    |  2 +-
 .../commons/compress/archivers/zip/ZipEncodingHelper.java | 15 +++++++--------
 .../apache/commons/compress/archivers/zip/ZipFile.java    |  2 +-
 .../apache/commons/compress/archivers/zip/ZipUtil.java    |  2 +-
 6 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java
index 2c1a7511b..ac2c549a9 100644
--- a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java
+++ b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java
@@ -38,6 +38,7 @@ import java.util.Map;
 import org.apache.commons.compress.archivers.ArchiveOutputStream;
 import org.apache.commons.compress.archivers.zip.ZipEncoding;
 import org.apache.commons.compress.archivers.zip.ZipEncodingHelper;
+import org.apache.commons.compress.utils.CharsetNames;
 import org.apache.commons.compress.utils.CountingOutputStream;
 import org.apache.commons.compress.utils.FixedLengthBlockOutputStream;
 import org.apache.commons.compress.utils.TimeUtils;
@@ -95,8 +96,8 @@ public class TarArchiveOutputStream extends ArchiveOutputStream<TarArchiveEntry>
     public static final int BIGNUMBER_POSIX = 2;
     private static final int RECORD_SIZE = 512;
 
-    private static final ZipEncoding ASCII =
-        ZipEncodingHelper.getZipEncoding("ASCII");
+    private static final ZipEncoding ASCII = ZipEncodingHelper.getZipEncoding(CharsetNames.US_ASCII);
+
     private static final int BLOCK_SIZE_UNSPECIFIED = -511;
     private long currSize;
     private String currName;
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java
index 846c12587..b79458d58 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java
@@ -779,7 +779,7 @@ public class ZipArchiveInputStream extends ArchiveInputStream<ZipArchiveEntry> i
 
         final GeneralPurposeBit gpFlag = GeneralPurposeBit.parse(lfhBuf, off);
         final boolean hasUTF8Flag = gpFlag.usesUTF8ForNames();
-        final ZipEncoding entryEncoding = hasUTF8Flag ? ZipEncodingHelper.UTF8_ZIP_ENCODING : zipEncoding;
+        final ZipEncoding entryEncoding = hasUTF8Flag ? ZipEncodingHelper.ZIP_ENCODING_UTF_8 : zipEncoding;
         current.hasDataDescriptor = gpFlag.usesDataDescriptor();
         current.entry.setGeneralPurposeBit(gpFlag);
 
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.java
index 768e5083e..fd036a6a8 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.java
@@ -1118,7 +1118,7 @@ public class ZipArchiveOutputStream extends ArchiveOutputStream<ZipArchiveEntry>
     private ZipEncoding getEntryEncoding(final ZipArchiveEntry ze) {
         final boolean encodable = zipEncoding.canEncode(ze.getName());
         return !encodable && fallbackToUTF8
-            ? ZipEncodingHelper.UTF8_ZIP_ENCODING : zipEncoding;
+            ? ZipEncodingHelper.ZIP_ENCODING_UTF_8 : zipEncoding;
     }
 
     private GeneralPurposeBit getGeneralPurposeBits(final boolean utfFallback, final boolean usesDataDescriptor) {
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncodingHelper.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncodingHelper.java
index 581e519cd..b6d86edee 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncodingHelper.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncodingHelper.java
@@ -24,6 +24,7 @@ import java.nio.charset.Charset;
 import java.nio.charset.UnsupportedCharsetException;
 
 import org.apache.commons.compress.utils.CharsetNames;
+import org.apache.commons.compress.utils.Charsets;
 
 /**
  * Static helper functions for robustly encoding file names in ZIP files.
@@ -31,9 +32,9 @@ import org.apache.commons.compress.utils.CharsetNames;
 public abstract class ZipEncodingHelper {
 
     /**
-     * the encoding UTF-8
+     * UTF-8.
      */
-    static final ZipEncoding UTF8_ZIP_ENCODING = getZipEncoding(CharsetNames.UTF_8);
+    static final ZipEncoding ZIP_ENCODING_UTF_8 = getZipEncoding(CharsetNames.UTF_8);
 
     /**
      * Instantiates a ZIP encoding. An NIO based character set encoder/decoder will be returned.
@@ -49,11 +50,9 @@ public abstract class ZipEncodingHelper {
      */
     public static ZipEncoding getZipEncoding(final String name) {
         Charset cs = Charset.defaultCharset();
-        if (name != null) {
-            try {
-                cs = Charset.forName(name);
-            } catch (final UnsupportedCharsetException e) { // NOSONAR we use the default encoding instead
-            }
+        try {
+            cs = Charsets.toCharset(name);
+        } catch (final UnsupportedCharsetException ignore) { // NOSONAR we use the default encoding instead
         }
         final boolean useReplacement = isUTF8(cs.name());
         return new NioZipEncoding(cs, useReplacement);
@@ -70,7 +69,7 @@ public abstract class ZipEncodingHelper {
     }
 
     /**
-     * Returns whether a given encoding is UTF-8. If the given name is null, then check the platform's default encoding.
+     * Tests whether a given encoding is UTF-8. If the given name is null, then check the platform's default encoding.
      *
      * @param charsetName If the given name is null, then check the platform's default encoding.
      */
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
index e4545200e..7df4cfdea 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
@@ -1175,7 +1175,7 @@ public class ZipFile implements Closeable {
 
         final GeneralPurposeBit gpFlag = GeneralPurposeBit.parse(cfhBuf, off);
         final boolean hasUTF8Flag = gpFlag.usesUTF8ForNames();
-        final ZipEncoding entryEncoding = hasUTF8Flag ? ZipEncodingHelper.UTF8_ZIP_ENCODING : zipEncoding;
+        final ZipEncoding entryEncoding = hasUTF8Flag ? ZipEncodingHelper.ZIP_ENCODING_UTF_8 : zipEncoding;
         if (hasUTF8Flag) {
             ze.setNameSource(ZipArchiveEntry.NameSource.NAME_WITH_EFS_FLAG);
         }
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
index 0e5247060..2d25a32e3 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
@@ -229,7 +229,7 @@ public abstract class ZipUtil {
             if (origCRC32 == f.getNameCRC32()) {
                 try {
                     return ZipEncodingHelper
-                        .UTF8_ZIP_ENCODING.decode(f.getUnicodeName());
+                        .ZIP_ENCODING_UTF_8.decode(f.getUnicodeName());
                 } catch (final IOException ex) {
                     // UTF-8 unsupported?  should be impossible the
                     // Unicode*ExtraField must contain some bad bytes