Apache Commons Compress 1.26.0 · org.apache.commons.compress.compressors.FileNameUtil

Field Summary

Modifier and Type	Field and Description
private final Map<String, String>	compressSuffix Map from common file name suffixes to the suffixes that identify compressed versions of those file types.
private final String	defaultExtension The format's default extension.
private final int	longestCompressedSuffix Length of the longest compressed suffix.
private final int	longestUncompressedSuffix Length of the longest uncompressed suffix.
private final int	shortestCompressedSuffix Length of the shortest compressed suffix.
private final int	shortestUncompressedSuffix Length of the shortest uncompressed suffix longer than the empty string.
private final Map<String, String>	uncompressSuffix Map from common file name suffixes of compressed files to the corresponding suffixes of uncompressed files.

Constructor Summary

Access	Constructor and Description
public	FileNameUtil(final Map<String, String> Map from common file name 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 file name when the file is uncompressed. uncompressSuffix, final String the format's default extension like ".gz" defaultExtension) sets up the utility with a map of known compressed to uncompressed suffix mappings and the default extension of the format.

Access

Constructor and Description

public

FileNameUtil(final Map<String, String>

Map from common file name 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 file name when the file is uncompressed.

uncompressSuffix, final String

the format's default extension like ".gz"

defaultExtension)

sets up the utility with a map of known compressed to uncompressed suffix mappings and the default extension of the format.

Method Summary

Modifier and Type	Method and Description
public 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.
public 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.
public 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 compressed file to the name that the file should have after uncompression.
public String	Returns: name of the corresponding uncompressed file getUncompressedFileName(final String name of a file fileName) Maps the given name of a compressed file to the name that the file should have after uncompression.
public boolean	Returns: `true` if the file name has a common format suffix, `false` otherwise isCompressedFilename(final String name of a file fileName) Deprecated Use `isCompressedFileName(String)`. Detects common format suffixes in the given file name.
public boolean	Returns: `true` if the file name has a common format suffix, `false` otherwise isCompressedFileName(final String name of a file fileName) Detects common format suffixes in the given file name.

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

Field Detail

compressSuffix	back to summary
private final Map<String, String> compressSuffix Map from common file name suffixes to the suffixes that identify compressed versions of those file types. For example: from ".tar" to ".tgz".

defaultExtension	back to summary
private final String defaultExtension The format's default extension.

longestCompressedSuffix	back to summary
private final int longestCompressedSuffix Length of the longest compressed suffix.

longestUncompressedSuffix	back to summary
private final int longestUncompressedSuffix Length of the longest uncompressed suffix.

shortestCompressedSuffix	back to summary
private final int shortestCompressedSuffix Length of the shortest compressed suffix.

shortestUncompressedSuffix	back to summary
private final int shortestUncompressedSuffix Length of the shortest uncompressed suffix longer than the empty string.

uncompressSuffix	back to summary
private final Map<String, String> uncompressSuffix Map from common file name 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 file name when the file is uncompressed.

uncompressSuffix

back to summary

private final Map<String, String> uncompressSuffix

Map from common file name 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 file name when the file is uncompressed.

Constructor Detail

FileNameUtil	back to summary
public FileNameUtil(final Map<String, String> uncompressSuffix, final String defaultExtension) sets up the utility with a map of known compressed to uncompressed suffix mappings and the default extension of the format. Parameters uncompressSuffix:Map<String, String> Map from common file name 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 file name when the file is uncompressed. defaultExtension:String the format's default extension like ".gz"

FileNameUtil

back to summary

public FileNameUtil(final Map<String, String> uncompressSuffix, final String defaultExtension)

sets up the utility with a map of known compressed to uncompressed suffix mappings and the default extension of the format.

Parameters

uncompressSuffix:Map<String, String>: Map from common file name 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 file name when the file is uncompressed.
defaultExtension:String: the format's default extension like ".gz"

Method Detail

getCompressedFilename back to summary

getCompressedFilename	back to summary
public String getCompressedFilename(final String fileName) Deprecated Use `getCompressedFileName(String)`. Maps the given file name 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 file name. Parameters fileName:String name of a file Returns:String name of the corresponding compressed file Annotations @Deprecated

public String getCompressedFilename(final String fileName)

Deprecated

Use getCompressedFileName(String).

Maps the given file name 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 file name.

Parameters

fileName:String: name of a file

Returns:String

name of the corresponding compressed file

Annotations

@Deprecated

getCompressedFileName	back to summary
public String getCompressedFileName(final String fileName) Maps the given file name 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 file name. Parameters fileName:String name of a file Returns:String name of the corresponding compressed file Since 1.25.0

getCompressedFileName

back to summary

public 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 String getUncompressedFilename(final String fileName) Deprecated Use `getUncompressedFileName(String)`. 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 file names 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 file name is returned unmapped. Parameters fileName:String name of a file Returns:String name of the corresponding uncompressed file Annotations @Deprecated

public String getUncompressedFilename(final String fileName)

Deprecated

Use getUncompressedFileName(String).

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 file names 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 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 String getUncompressedFileName(final String fileName) 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 file names 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 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 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 boolean isCompressedFilename(final String fileName) Deprecated Use `isCompressedFileName(String)`. Detects common format suffixes in the given file name. Parameters fileName:String name of a file Returns:boolean `true` if the file name has a common format suffix, `false` otherwise Annotations @Deprecated

public boolean isCompressedFilename(final String fileName)

Deprecated

Use isCompressedFileName(String).

Detects common format suffixes in the given file name.

Parameters

fileName:String: name of a file

Returns:boolean

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

Annotations

@Deprecated

isCompressedFileName back to summary

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

public boolean isCompressedFileName(final String fileName)

Detects common format suffixes in the given file name.

Parameters

fileName:String: name of a file

Returns:boolean

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

Since

1.25.0

public Class FileNameUtil

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail