Apache Commons Compress 1.26.0 · org.apache.commons.compress.compressors.bzip2.BZip2Utils

Modifier and Type	Field and Description
private static final FileNameUtil	fileNameUtil

Access	Constructor and Description
private	BZip2Utils() Private constructor to prevent instantiation of this utility class.

Method Summary

Modifier and Type	Method and Description
public static String	Returns: name of the corresponding compressed file getCompressedFilename(final String name of a file fileName) Deprecated Use `getCompressedFileName(String)`. Maps the given file name to the name that the file should have after compression with bzip2.
public static String	Returns: name of the corresponding compressed file getCompressedFileName(final String name of a file fileName) Maps the given file name to the name that the file should have after compression with bzip2.
public static String	Returns: name of the corresponding uncompressed file getUncompressedFilename(final String name of a file fileName) Deprecated Use `getUncompressedFileName(String)`. Maps the given name of a bzip2-compressed file to the name that the file should have after uncompression.
public static String	Returns: name of the corresponding uncompressed file getUncompressedFileName(final String name of a file fileName) Maps the given name of a bzip2-compressed file to the name that the file should have after uncompression.
public static boolean	Returns: `true` if the file name has a common bzip2 suffix, `false` otherwise isCompressedFilename(final String name of a file fileName) Deprecated Use `isCompressedFileName(String)`. Detects common bzip2 suffixes in the given file name.
public static boolean	Returns: `true` if the file name has a common bzip2 suffix, `false` otherwise isCompressedFileName(final String name of a file fileName) Detects common bzip2 suffixes in the given file name.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

fileNameUtil	back to summary
private static final FileNameUtil fileNameUtil

BZip2Utils	back to summary
private BZip2Utils() Private constructor to prevent instantiation of this utility class.

Method Detail

getCompressedFilename back to summary

getCompressedFilename	back to summary
public static String getCompressedFilename(final 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:String name of a file Returns:String name of the corresponding compressed file Annotations @Deprecated

public static String getCompressedFilename(final 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:String: name of a file

Returns:String

name of the corresponding compressed file

Annotations

@Deprecated

getCompressedFileName	back to summary
public static String getCompressedFileName(final 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:String name of a file Returns:String name of the corresponding compressed file Since 1.25.0

getCompressedFileName

back to summary

public static String getCompressedFileName(final String fileName)

Parameters

fileName:String: name of a file

Returns:String

name of the corresponding compressed file

Since

1.25.0

getUncompressedFilename back to summary

getUncompressedFilename	back to summary
public static String getUncompressedFilename(final 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:String name of a file Returns:String name of the corresponding uncompressed file Annotations @Deprecated

public static String getUncompressedFilename(final 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:String: name of a file

Returns:String

name of the corresponding uncompressed file

Annotations

@Deprecated

getUncompressedFileName	back to summary
public static String getUncompressedFileName(final 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:String name of a file Returns:String name of the corresponding uncompressed file Since 1.25.0

getUncompressedFileName

back to summary

public static String getUncompressedFileName(final String fileName)

Parameters

fileName:String: name of a file

Returns:String

name of the corresponding uncompressed file

Since

1.25.0

isCompressedFilename back to summary

isCompressedFilename	back to summary
public static boolean isCompressedFilename(final String fileName) Deprecated Use `isCompressedFileName(String)`. Detects common bzip2 suffixes in the given file name. Parameters fileName:String name of a file Returns:boolean `true` if the file name has a common bzip2 suffix, `false` otherwise Annotations @Deprecated

public static boolean isCompressedFilename(final String fileName)

Deprecated

Use isCompressedFileName(String).

Detects common bzip2 suffixes in the given file name.

Parameters

fileName:String: name of a file

Returns:boolean

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

Annotations

@Deprecated

isCompressedFileName back to summary

isCompressedFileName	back to summary
public static boolean isCompressedFileName(final String fileName) Detects common bzip2 suffixes in the given file name. Parameters fileName:String name of a file Returns:boolean `true` if the file name has a common bzip2 suffix, `false` otherwise Since 1.25.0

public static boolean isCompressedFileName(final String fileName)

Detects common bzip2 suffixes in the given file name.

Parameters

fileName:String: name of a file

Returns:boolean

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

Since

1.25.0

public abstract Class BZip2Utils

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail