Modifier and Type	Class and Description
pack-priv static enum	XZUtils.CachedAvailability

Modifier and Type	Field and Description
private static volatile XZUtils.CachedAvailability	cachedXZAvailability
private static final FileNameUtil	fileNameUtil
private static final byte[]	HEADER_MAGIC XZ Header Magic Bytes begin a XZ file.

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

Method Summary

Modifier and Type	Method and Description
pack-priv static XZUtils.CachedAvailability	getCachedXZAvailability()
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 xz.
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 xz.
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 xz-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 xz-compressed file to the name that the file should have after uncompression.
private static boolean	internalIsXZCompressionAvailable()
public static boolean	Returns: `true` if the file name has a common xz suffix, `false` otherwise isCompressedFilename(final String name of a file fileName) Deprecated Use `isCompressedFileName(String)`. Detects common xz suffixes in the given file name.
public static boolean	Returns: `true` if the file name has a common xz suffix, `false` otherwise isCompressedFileName(final String name of a file fileName) Detects common xz suffixes in the given file name.
public static boolean	Returns: true if the classes required to support XZ compression are available isXZCompressionAvailable() Are the classes required to support XZ compression available?
public static boolean	Returns: true if signature matches the .xz magic bytes, false otherwise matches(final byte[] the bytes to check signature, final int the number of bytes to check length) Checks if the signature matches what is expected for a .xz file.
public static void	setCacheXZAvailablity(final boolean whether to cache the result doCache) Whether to cache the result of the XZ for Java check.

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

Field Detail

cachedXZAvailability	back to summary
private static volatile XZUtils.CachedAvailability cachedXZAvailability

fileNameUtil	back to summary
private static final FileNameUtil fileNameUtil

HEADER_MAGIC back to summary

HEADER_MAGIC	back to summary
private static final byte[] HEADER_MAGIC XZ Header Magic Bytes begin a XZ file. This is a copy of `org.tukaani.xz.XZ.HEADER_MAGIC` in XZ for Java version 1.5.

private static final byte[] HEADER_MAGIC

XZ Header Magic Bytes begin a XZ file.

This is a copy of org.tukaani.xz.XZ.HEADER_MAGIC in XZ for Java version 1.5.

Constructor Detail

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

Method Detail

getCachedXZAvailability	back to summary
pack-priv static XZUtils.CachedAvailability getCachedXZAvailability()

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 xz. 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.txz". If no custom mapping is applicable, then the default ".xz" 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 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 xz. 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.txz". If no custom mapping is applicable, then the default ".xz" 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 static String getCompressedFileName(final String fileName) Maps the given file name to the name that the file should have after compression with xz. 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.txz". If no custom mapping is applicable, then the default ".xz" 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 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 xz-compressed file to the name that the file should have after uncompression. Commonly used file type specific suffixes like ".txz" are automatically detected and correctly mapped. For example the name "package.txz" is mapped to "package.tar". And any file names with the generic ".xz" suffix (or any other generic xz suffix) is mapped to a name without that suffix. If no xz 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 xz-compressed file to the name that the file should have after uncompression. Commonly used file type specific suffixes like ".txz" are automatically detected and correctly mapped. For example the name "package.txz" is mapped to "package.tar". And any file names with the generic ".xz" suffix (or any other generic xz suffix) is mapped to a name without that suffix. If no xz 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 xz-compressed file to the name that the file should have after uncompression. Commonly used file type specific suffixes like ".txz" are automatically detected and correctly mapped. For example the name "package.txz" is mapped to "package.tar". And any file names with the generic ".xz" suffix (or any other generic xz suffix) is mapped to a name without that suffix. If no xz 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

internalIsXZCompressionAvailable	back to summary
private static boolean internalIsXZCompressionAvailable()

isCompressedFilename back to summary

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

public static boolean isCompressedFilename(final String fileName)

Deprecated

Use isCompressedFileName(String).

Detects common xz suffixes in the given file name.

Parameters

fileName:String: name of a file

Returns:boolean

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

Annotations

@Deprecated

isCompressedFileName back to summary

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

public static boolean isCompressedFileName(final String fileName)

Detects common xz suffixes in the given file name.

Parameters

fileName:String: name of a file

Returns:boolean

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

Since

1.25.0

isXZCompressionAvailable	back to summary
public static boolean isXZCompressionAvailable() Are the classes required to support XZ compression available? Returns:boolean true if the classes required to support XZ compression are available Since 1.5

isXZCompressionAvailable

back to summary

public static boolean isXZCompressionAvailable()

Are the classes required to support XZ compression available?

Returns:boolean: true if the classes required to support XZ compression are available
Since: 1.5

matches back to summary

matches	back to summary
public static boolean matches(final byte[] signature, final int length) Checks if the signature matches what is expected for a .xz file. This is more or less a copy of the version found in `XZCompressorInputStream` but doesn't depend on the presence of XZ for Java. Parameters signature:byte[] the bytes to check length:int the number of bytes to check Returns:boolean true if signature matches the .xz magic bytes, false otherwise Since 1.9

public static boolean matches(final byte[] signature, final int length)

Checks if the signature matches what is expected for a .xz file.

This is more or less a copy of the version found in XZCompressorInputStream but doesn't depend on the presence of XZ for Java.

Parameters

signature:byte[]: the bytes to check
length:int: the number of bytes to check

Returns:boolean

true if signature matches the .xz magic bytes, false otherwise

Since

1.9

setCacheXZAvailablity back to summary

setCacheXZAvailablity	back to summary
public static void setCacheXZAvailablity(final boolean doCache) Whether to cache the result of the XZ for Java check. This defaults to `false` in an OSGi environment and `true` otherwise. Parameters doCache:boolean whether to cache the result Since 1.9

public static void setCacheXZAvailablity(final boolean doCache)

Whether to cache the result of the XZ for Java check.

This defaults to false in an OSGi environment and true otherwise.

Parameters

doCache:boolean: whether to cache the result

Since

1.9

org.apache.commons.compress.compressors.xz back to summary

pack-priv final Enum XZUtils.CachedAvailability

Class Inheritance

extends Enum<XZUtils.CachedAvailability>

java.lang.Object
java.lang.Enum
org.apache.commons.compress.compressors.xz.XZUtils.CachedAvailability

Field Summary

Modifier and Type	Field and Description
public static final XZUtils.CachedAvailability	CACHED_AVAILABLE
public static final XZUtils.CachedAvailability	CACHED_UNAVAILABLE
public static final XZUtils.CachedAvailability	DONT_CACHE

Constructor Summary

Access	Constructor and Description
private	CachedAvailability()

Method Summary

Modifier and Type	Method and Description
public static XZUtils.CachedAvailability	valueOf(String name)
public static XZUtils.CachedAvailability[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CACHED_AVAILABLE	back to summary
public static final XZUtils.CachedAvailability CACHED_AVAILABLE

CACHED_UNAVAILABLE	back to summary
public static final XZUtils.CachedAvailability CACHED_UNAVAILABLE

DONT_CACHE	back to summary
public static final XZUtils.CachedAvailability DONT_CACHE

Constructor Detail

CachedAvailability	back to summary
private CachedAvailability()

Method Detail

valueOf	back to summary
public static XZUtils.CachedAvailability valueOf(String name)

values	back to summary
public static XZUtils.CachedAvailability[] values()

public Class XZUtils

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum XZUtils.CachedAvailability

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail