org.apache.commons.compress.compressors.bzip2

Class BZip2Utils

java.lang.Object

org.apache.commons.compress.compressors.bzip2.BZip2Utils

public abstract class BZip2Utils
extends java.lang.Object

Utility code for the BZip2 compression format.

Since:

1.1

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getCompressedFilename(java.lang.String fileName) Deprecated. Use getCompressedFileName(String).
static java.lang.String	getCompressedFileName(java.lang.String fileName) Maps the given file name to the name that the file should have after compression with bzip2.
static java.lang.String	getUncompressedFilename(java.lang.String fileName) Deprecated. Use getUncompressedFileName(String).
static java.lang.String	getUncompressedFileName(java.lang.String fileName) Maps the given name of a bzip2-compressed file to the name that the file should have after uncompression.
static boolean	isCompressedFilename(java.lang.String fileName) Deprecated. Use isCompressedFileName(String).
static boolean	isCompressedFileName(java.lang.String fileName) Detects common bzip2 suffixes in the given file name.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCompressedFilename

@Deprecated
public static java.lang.String getCompressedFilename(java.lang.String fileName)

Deprecated. Use getCompressedFileName(String).

Maps the given file name to the name that the file should have after compression with bzip2. Currently this method simply appends the suffix ".bz2" to the file name based on the standard behavior of the "bzip2" program, but a future version may implement a more complex mapping if a new widely used naming pattern emerges.

Parameters:

fileName - name of a file

Returns:

name of the corresponding compressed file

getCompressedFileName

public static java.lang.String getCompressedFileName(java.lang.String fileName)

Maps the given file name to the name that the file should have after compression with bzip2. Currently this method simply appends the suffix ".bz2" to the file name based on the standard behavior of the "bzip2" program, but a future version may implement a more complex mapping if a new widely used naming pattern emerges.

Parameters:

fileName - name of a file

Returns:

name of the corresponding compressed file

Since:

1.25.0

getUncompressedFilename

@Deprecated
public static java.lang.String getUncompressedFilename(java.lang.String fileName)

Deprecated. Use getUncompressedFileName(String).

Maps the given name of a bzip2-compressed file to the name that the file should have after uncompression. Commonly used file type specific suffixes like ".tbz" or ".tbz2" are automatically detected and correctly mapped. For example the name "package.tbz2" is mapped to "package.tar". And any file names with the generic ".bz2" suffix (or any other generic bzip2 suffix) is mapped to a name without that suffix. If no bzip2 suffix is detected, then the file name is returned unmapped.

Parameters:

fileName - name of a file

Returns:

name of the corresponding uncompressed file

getUncompressedFileName

public static java.lang.String getUncompressedFileName(java.lang.String fileName)

Maps the given name of a bzip2-compressed file to the name that the file should have after uncompression. Commonly used file type specific suffixes like ".tbz" or ".tbz2" are automatically detected and correctly mapped. For example the name "package.tbz2" is mapped to "package.tar". And any file names with the generic ".bz2" suffix (or any other generic bzip2 suffix) is mapped to a name without that suffix. If no bzip2 suffix is detected, then the file name is returned unmapped.

Parameters:

fileName - name of a file

Returns:

name of the corresponding uncompressed file

Since:

1.25.0

isCompressedFilename

@Deprecated
public static boolean isCompressedFilename(java.lang.String fileName)

Deprecated. Use isCompressedFileName(String).

Detects common bzip2 suffixes in the given file name.

Parameters:

fileName - name of a file

Returns:

true if the file name has a common bzip2 suffix, false otherwise

isCompressedFileName

public static boolean isCompressedFileName(java.lang.String fileName)

Detects common bzip2 suffixes in the given file name.

Parameters:

fileName - name of a file

Returns:

true if the file name has a common bzip2 suffix, false otherwise

Since:

1.25.0