Top Description Inners Fields Constructors Methods
org.apache.commons.compress.compressors.brotli

public Class BrotliUtils

extends Object
Class Inheritance
Imports
org.apache.commons.compress.utils.OsgiUtils
Utility code for the Brotli compression format.
Since
1.14

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static enum
BrotliUtils.CachedAvailability

Field Summary

Modifier and TypeField and Description
private static volatile BrotliUtils.CachedAvailability
cachedBrotliAvailability

Constructor Summary

AccessConstructor and Description
private
BrotliUtils()

Private constructor to prevent instantiation of this utility class.

Method Summary

Modifier and TypeMethod and Description
pack-priv static BrotliUtils.CachedAvailability
getCachedBrotliAvailability()

private static boolean
internalIsBrotliCompressionAvailable()

public static boolean

Returns:

true if the classes required to support Brotli compression are available
isBrotliCompressionAvailable()

Are the classes required to support Brotli compression available?

public static void
setCacheBrotliAvailablity(final boolean
whether to cache the result
doCache)

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

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

cachedBrotliAvailabilityback to summary
private static volatile BrotliUtils.CachedAvailability cachedBrotliAvailability

Constructor Detail

BrotliUtilsback to summary
private BrotliUtils()

Private constructor to prevent instantiation of this utility class.

Method Detail

getCachedBrotliAvailabilityback to summary
pack-priv static BrotliUtils.CachedAvailability getCachedBrotliAvailability()
internalIsBrotliCompressionAvailableback to summary
private static boolean internalIsBrotliCompressionAvailable()
isBrotliCompressionAvailableback to summary
public static boolean isBrotliCompressionAvailable()

Are the classes required to support Brotli compression available?

Returns:boolean

true if the classes required to support Brotli compression are available

setCacheBrotliAvailablityback to summary
public static void setCacheBrotliAvailablity(final boolean doCache)

Whether to cache the result of the Brotli 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.brotli back to summary

pack-priv final Enum BrotliUtils.CachedAvailability

extends Enum<BrotliUtils.CachedAvailability>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final BrotliUtils.CachedAvailability
CACHED_AVAILABLE

public static final BrotliUtils.CachedAvailability
CACHED_UNAVAILABLE

public static final BrotliUtils.CachedAvailability
DONT_CACHE

Constructor Summary

AccessConstructor and Description
private
CachedAvailability()

Method Summary

Modifier and TypeMethod and Description
public static BrotliUtils.CachedAvailability
valueOf(String name)

public static BrotliUtils.CachedAvailability[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CACHED_AVAILABLEback to summary
public static final BrotliUtils.CachedAvailability CACHED_AVAILABLE
CACHED_UNAVAILABLEback to summary
public static final BrotliUtils.CachedAvailability CACHED_UNAVAILABLE
DONT_CACHEback to summary
public static final BrotliUtils.CachedAvailability DONT_CACHE

Constructor Detail

CachedAvailabilityback to summary
private CachedAvailability()

Method Detail

valueOfback to summary
public static BrotliUtils.CachedAvailability valueOf(String name)
valuesback to summary
public static BrotliUtils.CachedAvailability[] values()