Top Description Constructors Methods
org.tukaani.xz

public abstract Class FilterOptions

extends Object
implements Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable
Known Direct Subclasses
org.tukaani.xz.LZMA2Options, org.tukaani.xz.BCJOptions, org.tukaani.xz.DeltaOptions
Imports
java.io.InputStream, .IOException

Base class for filter-specific options classes.

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public static int
getDecoderMemoryUsage(FilterOptions[] options)

Gets how much memory the decoder will need with the given filter chain.

public abstract int
getDecoderMemoryUsage()

Gets how much memory the decoder will need to decompress the data that was encoded with these options.

public static int
getEncoderMemoryUsage(FilterOptions[] options)

Gets how much memory the encoder will need with the given filter chain.

public abstract int
getEncoderMemoryUsage()

Gets how much memory the encoder will need with these options.

pack-priv abstract FilterEncoder
public InputStream
getInputStream(InputStream in)

Gets a raw (no XZ headers) decoder input stream using these options.

public abstract InputStream
getInputStream(InputStream in, ArrayCache arrayCache)

Gets a raw (no XZ headers) decoder input stream using these options and the given ArrayCache.

public FinishableOutputStream
getOutputStream(FinishableOutputStream out)

Gets a raw (no XZ headers) encoder output stream using these options.

public abstract FinishableOutputStream
getOutputStream(FinishableOutputStream out, ArrayCache arrayCache)

Gets a raw (no XZ headers) encoder output stream using these options and the given ArrayCache.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

FilterOptionsback to summary
pack-priv FilterOptions()

Method Detail

getDecoderMemoryUsageback to summary
public static int getDecoderMemoryUsage(FilterOptions[] options)

Gets how much memory the decoder will need with the given filter chain. This function simply calls getDecoderMemoryUsage() for every filter in the array and returns the sum of the returned values.

getDecoderMemoryUsageback to summary
public abstract int getDecoderMemoryUsage()

Gets how much memory the decoder will need to decompress the data that was encoded with these options.

getEncoderMemoryUsageback to summary
public static int getEncoderMemoryUsage(FilterOptions[] options)

Gets how much memory the encoder will need with the given filter chain. This function simply calls getEncoderMemoryUsage() for every filter in the array and returns the sum of the returned values.

getEncoderMemoryUsageback to summary
public abstract int getEncoderMemoryUsage()

Gets how much memory the encoder will need with these options.

getFilterEncoderback to summary
pack-priv abstract FilterEncoder getFilterEncoder()
getInputStreamback to summary
public InputStream getInputStream(InputStream in) throws IOException

Gets a raw (no XZ headers) decoder input stream using these options.

This is uses ArrayCache.getDefaultCache() as the ArrayCache.

getInputStreamback to summary
public abstract InputStream getInputStream(InputStream in, ArrayCache arrayCache) throws IOException

Gets a raw (no XZ headers) decoder input stream using these options and the given ArrayCache.

getOutputStreamback to summary
public FinishableOutputStream getOutputStream(FinishableOutputStream out)

Gets a raw (no XZ headers) encoder output stream using these options. Raw streams are an advanced feature. In most cases you want to store the compressed data in the .xz container format instead of using a raw stream. To use this filter in a .xz file, pass this object to XZOutputStream.

This is uses ArrayCache.getDefaultCache() as the ArrayCache.

getOutputStreamback to summary
public abstract FinishableOutputStream getOutputStream(FinishableOutputStream out, ArrayCache arrayCache)

Gets a raw (no XZ headers) encoder output stream using these options and the given ArrayCache. Raw streams are an advanced feature. In most cases you want to store the compressed data in the .xz container format instead of using a raw stream. To use this filter in a .xz file, pass this object to XZOutputStream.