Compress-LZF 1.1.2 · com.ning.compress.lzf.LZFEncoder

Modifier and Type	Field and Description
private static final int	FULL_UNCOMP_ENCODED_CHUNK
public static final int	MAX_CHUNK_RESULT_SIZE
private static final int	MAX_CHUNK_WORKSPACE_SIZE

Access	Constructor and Description
private	LZFEncoder()

Method Summary

Modifier and Type	Method and Description
public static int	appendEncoded(byte[] input, int inputPtr, int inputLength, byte[] outputBuffer, int outputPtr) Alternate version that accepts pre-allocated output buffer.
public static int	appendEncoded(byte[] input, int inputPtr, int inputLength, byte[] outputBuffer, int outputPtr, BufferRecycler bufferRecycler) Alternate version that accepts pre-allocated output buffer.
public static int	appendEncoded(ChunkEncoder enc, byte[] input, int inputPtr, int inputLength, byte[] outputBuffer, int outputPtr) Alternate version that accepts pre-allocated output buffer.
public static byte[]	encode(byte[] data) Method for compressing given input data using LZF encoding and block structure (compatible with lzf command line utility).
public static byte[]	encode(byte[] data, int offset, int length) Method for compressing given input data using LZF encoding and block structure (compatible with lzf command line utility).
public static byte[]	encode(byte[] data, int offset, int length, BufferRecycler bufferRecycler) Method for compressing given input data using LZF encoding and block structure (compatible with lzf command line utility).
public static byte[]	encode(ChunkEncoder enc, byte[] data, int length) Compression method that uses specified `ChunkEncoder` for actual encoding.
public static byte[]	encode(ChunkEncoder enc, byte[] data, int offset, int length) Method that encodes given input using provided `ChunkEncoder`, and aggregating it into a single byte array and returning that.
public static int	estimateMaxWorkspaceSize(int inputSize) Helper method that can be used to estimate maximum space needed to try compression of given amount of data.
public static int	safeAppendEncoded(byte[] input, int inputPtr, int inputLength, byte[] outputBuffer, int outputPtr) Alternate version that accepts pre-allocated output buffer.
public static int	safeAppendEncoded(byte[] input, int inputPtr, int inputLength, byte[] outputBuffer, int outputPtr, BufferRecycler bufferRecycler) Alternate version that accepts pre-allocated output buffer.
public static byte[]	safeEncode(byte[] data) Method that will use "safe" `ChunkEncoder`, as produced by `ChunkEncoderFactory#safeInstance`, for encoding.
public static byte[]	safeEncode(byte[] data, int offset, int length) Method that will use "safe" `ChunkEncoder`, as produced by `ChunkEncoderFactory#safeInstance`, for encoding.
public static byte[]	safeEncode(byte[] data, int offset, int length, BufferRecycler bufferRecycler) Method that will use "safe" `ChunkEncoder`, as produced by `ChunkEncoderFactory#safeInstance`, for encoding.

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

FULL_UNCOMP_ENCODED_CHUNK	back to summary
private static final int FULL_UNCOMP_ENCODED_CHUNK

MAX_CHUNK_RESULT_SIZE	back to summary
public static final int MAX_CHUNK_RESULT_SIZE

MAX_CHUNK_WORKSPACE_SIZE	back to summary
private static final int MAX_CHUNK_WORKSPACE_SIZE

LZFEncoder	back to summary
private LZFEncoder()

Method Detail

appendEncoded back to summary

appendEncoded	back to summary
public static int appendEncoded(byte[] input, int inputPtr, int inputLength, byte[] outputBuffer, int outputPtr) Alternate version that accepts pre-allocated output buffer. Note that `ChunkEncoder` instance used is one produced by `ChunkEncoderFactory#optimalNonAllocatingInstance`, which typically is "unsafe" instance if one can be used on current JVM.

public static int appendEncoded(byte[] input, int inputPtr, int inputLength, byte[] outputBuffer, int outputPtr)

Alternate version that accepts pre-allocated output buffer.

Note that ChunkEncoder instance used is one produced by ChunkEncoderFactory#optimalNonAllocatingInstance, which typically is "unsafe" instance if one can be used on current JVM.

appendEncoded back to summary

appendEncoded	back to summary
public static int appendEncoded(byte[] input, int inputPtr, int inputLength, byte[] outputBuffer, int outputPtr, BufferRecycler bufferRecycler) Alternate version that accepts pre-allocated output buffer. Note that `ChunkEncoder` instance used is one produced by `ChunkEncoderFactory#optimalNonAllocatingInstance`, which typically is "unsafe" instance if one can be used on current JVM.

public static int appendEncoded(byte[] input, int inputPtr, int inputLength, byte[] outputBuffer, int outputPtr, BufferRecycler bufferRecycler)

Alternate version that accepts pre-allocated output buffer.

Note that ChunkEncoder instance used is one produced by ChunkEncoderFactory#optimalNonAllocatingInstance, which typically is "unsafe" instance if one can be used on current JVM.

appendEncoded	back to summary
public static int appendEncoded(ChunkEncoder enc, byte[] input, int inputPtr, int inputLength, byte[] outputBuffer, int outputPtr) Alternate version that accepts pre-allocated output buffer.

encode back to summary

encode	back to summary
public static byte[] encode(byte[] data) Method for compressing given input data using LZF encoding and block structure (compatible with lzf command line utility). Result consists of a sequence of chunks. Note that `ChunkEncoder` instance used is one produced by `ChunkEncoderFactory#optimalInstance`, which typically is "unsafe" instance if one can be used on current JVM.

public static byte[] encode(byte[] data)

Method for compressing given input data using LZF encoding and block structure (compatible with lzf command line utility). Result consists of a sequence of chunks.

Note that ChunkEncoder instance used is one produced by ChunkEncoderFactory#optimalInstance, which typically is "unsafe" instance if one can be used on current JVM.

encode back to summary

encode	back to summary
public static byte[] encode(byte[] data, int offset, int length) Method for compressing given input data using LZF encoding and block structure (compatible with lzf command line utility). Result consists of a sequence of chunks. Note that `ChunkEncoder` instance used is one produced by `ChunkEncoderFactory#optimalInstance`, which typically is "unsafe" instance if one can be used on current JVM.

public static byte[] encode(byte[] data, int offset, int length)

Method for compressing given input data using LZF encoding and block structure (compatible with lzf command line utility). Result consists of a sequence of chunks.

Note that ChunkEncoder instance used is one produced by ChunkEncoderFactory#optimalInstance, which typically is "unsafe" instance if one can be used on current JVM.

encode back to summary

encode	back to summary
public static byte[] encode(byte[] data, int offset, int length, BufferRecycler bufferRecycler) Method for compressing given input data using LZF encoding and block structure (compatible with lzf command line utility). Result consists of a sequence of chunks. Note that `ChunkEncoder` instance used is one produced by `ChunkEncoderFactory#optimalInstance`, which typically is "unsafe" instance if one can be used on current JVM.

public static byte[] encode(byte[] data, int offset, int length, BufferRecycler bufferRecycler)

Method for compressing given input data using LZF encoding and block structure (compatible with lzf command line utility). Result consists of a sequence of chunks.

Note that ChunkEncoder instance used is one produced by ChunkEncoderFactory#optimalInstance, which typically is "unsafe" instance if one can be used on current JVM.

encode	back to summary
public static byte[] encode(ChunkEncoder enc, byte[] data, int length) Compression method that uses specified `ChunkEncoder` for actual encoding.

encode	back to summary
public static byte[] encode(ChunkEncoder enc, byte[] data, int offset, int length) Method that encodes given input using provided `ChunkEncoder`, and aggregating it into a single byte array and returning that. Note method does NOT call `ChunkEncoder#close`; caller is responsible for doing that after it is done using the encoder.

estimateMaxWorkspaceSize	back to summary
public static int estimateMaxWorkspaceSize(int inputSize) Helper method that can be used to estimate maximum space needed to try compression of given amount of data. This is slightly larger than maximum resulting content since compressor has a choice of uncompressed chunks to use, but that is only done after compression fails to reduce size; and this temporary expansion of up to 3.3% or so (1 indicator for every 31 bytes of uncompressed data) is more than what eventual expansion would be (5 bytes header per each uncompressed chunk, usually 0.01%).

estimateMaxWorkspaceSize

back to summary

public static int estimateMaxWorkspaceSize(int inputSize)

Helper method that can be used to estimate maximum space needed to try compression of given amount of data. This is slightly larger than maximum resulting content since compressor has a choice of uncompressed chunks to use, but that is only done after compression fails to reduce size; and this temporary expansion of up to 3.3% or so (1 indicator for every 31 bytes of uncompressed data) is more than what eventual expansion would be (5 bytes header per each uncompressed chunk, usually 0.01%).

safeAppendEncoded back to summary

safeAppendEncoded	back to summary
public static int safeAppendEncoded(byte[] input, int inputPtr, int inputLength, byte[] outputBuffer, int outputPtr) Alternate version that accepts pre-allocated output buffer. Method that will use "safe" `ChunkEncoder`, as produced by `ChunkEncoderFactory#safeInstance`, for encoding. Safe here means that it does not use any non-compliant features beyond core JDK.

public static int safeAppendEncoded(byte[] input, int inputPtr, int inputLength, byte[] outputBuffer, int outputPtr)

Alternate version that accepts pre-allocated output buffer.

Method that will use "safe" ChunkEncoder, as produced by ChunkEncoderFactory#safeInstance, for encoding. Safe here means that it does not use any non-compliant features beyond core JDK.

safeAppendEncoded back to summary

safeAppendEncoded	back to summary
public static int safeAppendEncoded(byte[] input, int inputPtr, int inputLength, byte[] outputBuffer, int outputPtr, BufferRecycler bufferRecycler) Alternate version that accepts pre-allocated output buffer. Method that will use "safe" `ChunkEncoder`, as produced by `ChunkEncoderFactory#safeInstance`, for encoding. Safe here means that it does not use any non-compliant features beyond core JDK.

public static int safeAppendEncoded(byte[] input, int inputPtr, int inputLength, byte[] outputBuffer, int outputPtr, BufferRecycler bufferRecycler)

Alternate version that accepts pre-allocated output buffer.

Method that will use "safe" ChunkEncoder, as produced by ChunkEncoderFactory#safeInstance, for encoding. Safe here means that it does not use any non-compliant features beyond core JDK.

safeEncode	back to summary
public static byte[] safeEncode(byte[] data) Method that will use "safe" `ChunkEncoder`, as produced by `ChunkEncoderFactory#safeInstance`, for encoding. Safe here means that it does not use any non-compliant features beyond core JDK.

safeEncode	back to summary
public static byte[] safeEncode(byte[] data, int offset, int length) Method that will use "safe" `ChunkEncoder`, as produced by `ChunkEncoderFactory#safeInstance`, for encoding. Safe here means that it does not use any non-compliant features beyond core JDK.

safeEncode	back to summary
public static byte[] safeEncode(byte[] data, int offset, int length, BufferRecycler bufferRecycler) Method that will use "safe" `ChunkEncoder`, as produced by `ChunkEncoderFactory#safeInstance`, for encoding. Safe here means that it does not use any non-compliant features beyond core JDK.

public Class LZFEncoder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail