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

Field Summary

Modifier and Type	Field and Description
private static volatile ZstdUtils.CachedAvailability	cachedZstdAvailability
private static final byte[]	SKIPPABLE_FRAME_MAGIC Skippable Frame Magic Bytes - the three common bytes.
private static final byte[]	ZSTANDARD_FRAME_MAGIC Zstandard Frame Magic Bytes.

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

Method Summary

Modifier and Type	Method and Description
pack-priv static ZstdUtils.CachedAvailability	getCachedZstdAvailability()
private static boolean	internalIsZstdCompressionAvailable()
public static boolean	Returns: true if the classes required to support Zstandard compression are available isZstdCompressionAvailable() Are the classes required to support Zstandard compression available?
public static boolean	Returns: true if signature matches the Ztstandard or skippable frame 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 Zstandard file.
public static void	setCacheZstdAvailablity(final boolean whether to cache the result doCache) Whether to cache the result of the Zstandard for Java check.

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

Field Detail

cachedZstdAvailability	back to summary
private static volatile ZstdUtils.CachedAvailability cachedZstdAvailability

SKIPPABLE_FRAME_MAGIC	back to summary
private static final byte[] SKIPPABLE_FRAME_MAGIC Skippable Frame Magic Bytes - the three common bytes.

ZSTANDARD_FRAME_MAGIC	back to summary
private static final byte[] ZSTANDARD_FRAME_MAGIC Zstandard Frame Magic Bytes.

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

Method Detail

getCachedZstdAvailability	back to summary
pack-priv static ZstdUtils.CachedAvailability getCachedZstdAvailability()

internalIsZstdCompressionAvailable	back to summary
private static boolean internalIsZstdCompressionAvailable()

isZstdCompressionAvailable	back to summary
public static boolean isZstdCompressionAvailable() Are the classes required to support Zstandard compression available? Returns:boolean true if the classes required to support Zstandard compression are available

isZstdCompressionAvailable

back to summary

public static boolean isZstdCompressionAvailable()

Are the classes required to support Zstandard compression available?

Returns:boolean: true if the classes required to support Zstandard compression are available

matches	back to summary
public static boolean matches(final byte[] signature, final int length) Checks if the signature matches what is expected for a Zstandard file. Parameters signature:byte[] the bytes to check length:int the number of bytes to check Returns:boolean true if signature matches the Ztstandard or skippable frame magic bytes, false otherwise

matches

back to summary

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

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

Parameters

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

Returns:boolean

true if signature matches the Ztstandard or skippable frame magic bytes, false otherwise

setCacheZstdAvailablity back to summary

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

public static void setCacheZstdAvailablity(final boolean doCache)

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

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

Parameters

doCache:boolean: whether to cache the result

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

pack-priv final Enum ZstdUtils.CachedAvailability

Class Inheritance

extends Enum<ZstdUtils.CachedAvailability>

java.lang.Object
java.lang.Enum
org.apache.commons.compress.compressors.zstandard.ZstdUtils.CachedAvailability

Field Summary

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

Constructor Summary

Access	Constructor and Description
private	CachedAvailability()

Method Summary

Modifier and Type	Method and Description
public static ZstdUtils.CachedAvailability	valueOf(String name)
public static ZstdUtils.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 ZstdUtils.CachedAvailability CACHED_AVAILABLE

CACHED_UNAVAILABLE	back to summary
public static final ZstdUtils.CachedAvailability CACHED_UNAVAILABLE

DONT_CACHE	back to summary
public static final ZstdUtils.CachedAvailability DONT_CACHE

Constructor Detail

CachedAvailability	back to summary
private CachedAvailability()

Method Detail

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

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

public Class ZstdUtils

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum ZstdUtils.CachedAvailability

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail