com.ning.compress.lzf.util

Class ChunkEncoderFactory

java.lang.Object

com.ning.compress.lzf.util.ChunkEncoderFactory

public class ChunkEncoderFactory
extends Object

Simple helper class used for loading ChunkEncoder implementations, based on criteria such as "fastest available" or "safe to run anywhere".

Constructor Summary

Constructors

Constructor and Description
ChunkEncoderFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static ChunkEncoder	optimalInstance() Convenience method, equivalent to: return optimalInstance(LZFChunk.MAX_CHUNK_LEN);
static ChunkEncoder	optimalInstance(BufferRecycler bufferRecycler) Convenience method, equivalent to: return optimalInstance(LZFChunk.MAX_CHUNK_LEN, bufferRecycler);
static ChunkEncoder	optimalInstance(int totalLength) Method to use for getting compressor instance that uses the most optimal available methods for underlying data access.
static ChunkEncoder	optimalInstance(int totalLength, BufferRecycler bufferRecycler) Method to use for getting compressor instance that uses the most optimal available methods for underlying data access.
static ChunkEncoder	optimalNonAllocatingInstance(int totalLength) Factory method for constructing encoder that is always passed buffer externally, so that it will not (nor need) allocate encoding buffer.
static ChunkEncoder	optimalNonAllocatingInstance(int totalLength, BufferRecycler bufferRecycler) Factory method for constructing encoder that is always passed buffer externally, so that it will not (nor need) allocate encoding buffer.
static ChunkEncoder	safeInstance() Convenience method, equivalent to: return safeInstance(LZFChunk.MAX_CHUNK_LEN);
static ChunkEncoder	safeInstance(BufferRecycler bufferRecycler) Convenience method, equivalent to: return safeInstance(LZFChunk.MAX_CHUNK_LEN, bufferRecycler);
static ChunkEncoder	safeInstance(int totalLength) Method that can be used to ensure that a "safe" compressor instance is loaded.
static ChunkEncoder	safeInstance(int totalLength, BufferRecycler bufferRecycler) Method that can be used to ensure that a "safe" compressor instance is loaded.
static ChunkEncoder	safeNonAllocatingInstance(int totalLength) Factory method for constructing encoder that is always passed buffer externally, so that it will not (nor need) allocate encoding buffer.
static ChunkEncoder	safeNonAllocatingInstance(int totalLength, BufferRecycler bufferRecycler) Factory method for constructing encoder that is always passed buffer externally, so that it will not (nor need) allocate encoding buffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChunkEncoderFactory

public ChunkEncoderFactory()

Method Detail

optimalInstance

public static ChunkEncoder optimalInstance()

Convenience method, equivalent to: return optimalInstance(LZFChunk.MAX_CHUNK_LEN);

optimalInstance

public static ChunkEncoder optimalInstance(int totalLength)

Method to use for getting compressor instance that uses the most optimal available methods for underlying data access. It should be safe to call this method as implementations are dynamically loaded; however, on some non-standard platforms it may be necessary to either directly load instances, or use safeInstance().

Uses a ThreadLocal soft-referenced BufferRecycler instance.

Parameters:

totalLength - Expected total length of content to compress; only matters for content that is smaller than maximum chunk size (64k), to optimize encoding hash tables

optimalNonAllocatingInstance

public static ChunkEncoder optimalNonAllocatingInstance(int totalLength)

Factory method for constructing encoder that is always passed buffer externally, so that it will not (nor need) allocate encoding buffer.

Uses a ThreadLocal soft-referenced BufferRecycler instance.

safeInstance

public static ChunkEncoder safeInstance()

Convenience method, equivalent to: return safeInstance(LZFChunk.MAX_CHUNK_LEN);

safeInstance

public static ChunkEncoder safeInstance(int totalLength)

Method that can be used to ensure that a "safe" compressor instance is loaded. Safe here means that it should work on any and all Java platforms.

Uses a ThreadLocal soft-referenced BufferRecycler instance.

Parameters:

totalLength - Expected total length of content to compress; only matters for content that is smaller than maximum chunk size (64k), to optimize encoding hash tables

safeNonAllocatingInstance

public static ChunkEncoder safeNonAllocatingInstance(int totalLength)

Factory method for constructing encoder that is always passed buffer externally, so that it will not (nor need) allocate encoding buffer.

Uses a ThreadLocal soft-referenced BufferRecycler instance.

optimalInstance

public static ChunkEncoder optimalInstance(BufferRecycler bufferRecycler)

Convenience method, equivalent to: return optimalInstance(LZFChunk.MAX_CHUNK_LEN, bufferRecycler);

optimalInstance

public static ChunkEncoder optimalInstance(int totalLength,
                           BufferRecycler bufferRecycler)

Method to use for getting compressor instance that uses the most optimal available methods for underlying data access. It should be safe to call this method as implementations are dynamically loaded; however, on some non-standard platforms it may be necessary to either directly load instances, or use safeInstance().

Parameters:

totalLength - Expected total length of content to compress; only matters for content that is smaller than maximum chunk size (64k), to optimize encoding hash tables

bufferRecycler - The BufferRecycler instance

optimalNonAllocatingInstance

public static ChunkEncoder optimalNonAllocatingInstance(int totalLength,
                                        BufferRecycler bufferRecycler)

Factory method for constructing encoder that is always passed buffer externally, so that it will not (nor need) allocate encoding buffer.

safeInstance

public static ChunkEncoder safeInstance(BufferRecycler bufferRecycler)

Convenience method, equivalent to: return safeInstance(LZFChunk.MAX_CHUNK_LEN, bufferRecycler);

safeInstance

public static ChunkEncoder safeInstance(int totalLength,
                        BufferRecycler bufferRecycler)

Method that can be used to ensure that a "safe" compressor instance is loaded. Safe here means that it should work on any and all Java platforms.

Parameters:

totalLength - Expected total length of content to compress; only matters for content that is smaller than maximum chunk size (64k), to optimize encoding hash tables

bufferRecycler - The BufferRecycler instance

safeNonAllocatingInstance

public static ChunkEncoder safeNonAllocatingInstance(int totalLength,
                                     BufferRecycler bufferRecycler)

Factory method for constructing encoder that is always passed buffer externally, so that it will not (nor need) allocate encoding buffer.