All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.commons.compress.compressors.FileNameUtil Maven / Gradle / Ivy

Go to download

Apache Commons Compress defines an API for working with compression and archive formats. These include bzip2, gzip, pack200, LZMA, XZ, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4, Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z, arj.

There is a newer version: 1.27.1
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.commons.compress.compressors;

import java.util.Collections;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;

/**
 * File name mapping code for the compression formats.
 * @ThreadSafe
 * @since 1.4
 */
public class FileNameUtil {

    /**
     * Map from common filename suffixes to the suffixes that identify compressed
     * versions of those file types. For example: from ".tar" to ".tgz".
     */
    private final Map compressSuffix =
        new HashMap();

    /**
     * Map from common filename suffixes of compressed files to the
     * corresponding suffixes of uncompressed files. For example: from
     * ".tgz" to ".tar".
     * 

* This map also contains format-specific suffixes like ".gz" and "-z". * These suffixes are mapped to the empty string, as they should simply * be removed from the filename when the file is uncompressed. */ private final Map uncompressSuffix; /** * Length of the longest compressed suffix. */ private final int longestCompressedSuffix; /** * Length of the shortest compressed suffix. */ private final int shortestCompressedSuffix; /** * Length of the longest uncompressed suffix. */ private final int longestUncompressedSuffix; /** * Length of the shortest uncompressed suffix longer than the * empty string. */ private final int shortestUncompressedSuffix; /** * The format's default extension. */ private final String defaultExtension; /** * sets up the utility with a map of known compressed to * uncompressed suffix mappings and the default extension of the * format. * * @param uncompressSuffix Map from common filename suffixes of * compressed files to the corresponding suffixes of uncompressed * files. For example: from ".tgz" to ".tar". This map also * contains format-specific suffixes like ".gz" and "-z". These * suffixes are mapped to the empty string, as they should simply * be removed from the filename when the file is uncompressed. * * @param defaultExtension the format's default extension like ".gz" */ public FileNameUtil(Map uncompressSuffix, String defaultExtension) { this.uncompressSuffix = Collections.unmodifiableMap(uncompressSuffix); int lc = Integer.MIN_VALUE, sc = Integer.MAX_VALUE; int lu = Integer.MIN_VALUE, su = Integer.MAX_VALUE; for (Map.Entry ent : uncompressSuffix.entrySet()) { int cl = ent.getKey().length(); if (cl > lc) { lc = cl; } if (cl < sc) { sc = cl; } String u = ent.getValue(); int ul = u.length(); if (ul > 0) { if (!compressSuffix.containsKey(u)) { compressSuffix.put(u, ent.getKey()); } if (ul > lu) { lu = ul; } if (ul < su) { su = ul; } } } longestCompressedSuffix = lc; longestUncompressedSuffix = lu; shortestCompressedSuffix = sc; shortestUncompressedSuffix = su; this.defaultExtension = defaultExtension; } /** * Detects common format suffixes in the given filename. * * @param filename name of a file * @return {@code true} if the filename has a common format suffix, * {@code false} otherwise */ public boolean isCompressedFilename(String filename) { final String lower = filename.toLowerCase(Locale.ENGLISH); final int n = lower.length(); for (int i = shortestCompressedSuffix; i <= longestCompressedSuffix && i < n; i++) { if (uncompressSuffix.containsKey(lower.substring(n - i))) { return true; } } return false; } /** * Maps the given name of a compressed file to the name that the * file should have after uncompression. Commonly used file type specific * suffixes like ".tgz" or ".svgz" are automatically detected and * correctly mapped. For example the name "package.tgz" is mapped to * "package.tar". And any filenames with the generic ".gz" suffix * (or any other generic gzip suffix) is mapped to a name without that * suffix. If no format suffix is detected, then the filename is returned * unmapped. * * @param filename name of a file * @return name of the corresponding uncompressed file */ public String getUncompressedFilename(String filename) { final String lower = filename.toLowerCase(Locale.ENGLISH); final int n = lower.length(); for (int i = shortestCompressedSuffix; i <= longestCompressedSuffix && i < n; i++) { String suffix = uncompressSuffix.get(lower.substring(n - i)); if (suffix != null) { return filename.substring(0, n - i) + suffix; } } return filename; } /** * Maps the given filename to the name that the file should have after * compression. Common file types with custom suffixes for * compressed versions are automatically detected and correctly mapped. * For example the name "package.tar" is mapped to "package.tgz". If no * custom mapping is applicable, then the default ".gz" suffix is appended * to the filename. * * @param filename name of a file * @return name of the corresponding compressed file */ public String getCompressedFilename(String filename) { final String lower = filename.toLowerCase(Locale.ENGLISH); final int n = lower.length(); for (int i = shortestUncompressedSuffix; i <= longestUncompressedSuffix && i < n; i++) { String suffix = compressSuffix.get(lower.substring(n - i)); if (suffix != null) { return filename.substring(0, n - i) + suffix; } } // No custom suffix found, just append the default return filename + defaultExtension; } }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy