Index (Ning-compress-LZF 0.9.2 API)

A B C D E F G H I L M N O P R S U V W _

A

allocDecodeBuffer(int) - Method in class com.ning.compress.lzf.BufferRecycler
allocEncodingBuffer(int) - Method in class com.ning.compress.lzf.BufferRecycler
allocEncodingHash(int) - Method in class com.ning.compress.lzf.BufferRecycler
allocInputBuffer(int) - Method in class com.ning.compress.lzf.BufferRecycler
allocOutputBuffer(int) - Method in class com.ning.compress.lzf.BufferRecycler
available() - Method in class com.ning.compress.lzf.LZFInputStream: Method is overridden to report number of bytes that can now be read from decoded data buffer, without reading bytes from the underlying stream.
available() - Method in class com.ning.compress.lzf.util.LZFFileInputStream

B

BLOCK_TYPE_COMPRESSED - Static variable in class com.ning.compress.lzf.LZFChunk
BLOCK_TYPE_NON_COMPRESSED - Static variable in class com.ning.compress.lzf.LZFChunk
BufferRecycler - Class in com.ning.compress.lzf: Simple helper class to encapsulate details of basic buffer recycling scheme, which helps a lot (as per profiling) for smaller encoding cases.
BufferRecycler() - Constructor for class com.ning.compress.lzf.BufferRecycler
BYTE_NULL - Static variable in class com.ning.compress.lzf.ChunkDecoder
BYTE_V - Static variable in class com.ning.compress.lzf.LZFChunk
BYTE_Z - Static variable in class com.ning.compress.lzf.LZFChunk

C

calculateUncompressedSize(byte[], int, int) - Static method in class com.ning.compress.lzf.ChunkDecoder: Helper method that will calculate total uncompressed size, for sequence of one or more LZF blocks stored in given byte array.
calculateUncompressedSize(byte[], int, int) - Static method in class com.ning.compress.lzf.LZFDecoder
checkNotClosed() - Method in class com.ning.compress.lzf.LZFOutputStream
checkNotClosed() - Method in class com.ning.compress.lzf.util.LZFFileOutputStream
ChunkDecoder - Class in com.ning.compress.lzf: Decoder that handles decoding of sequence of encoded LZF chunks, combining them into a single contiguous result byte array.
ChunkDecoder() - Constructor for class com.ning.compress.lzf.ChunkDecoder
ChunkDecoderFactory - Class in com.ning.compress.lzf.util: Simple helper class used for loading ChunkDecoder implementations, based on criteria such as "fastest available".
ChunkEncoder - Class in com.ning.compress.lzf: Class that handles actual encoding of individual chunks.
ChunkEncoder(int) - Constructor for class com.ning.compress.lzf.ChunkEncoder
close() - Method in class com.ning.compress.lzf.ChunkEncoder: Method to close once encoder is no longer in use.
close() - Method in class com.ning.compress.lzf.LZFInputStream
close() - Method in class com.ning.compress.lzf.LZFOutputStream
close() - Method in class com.ning.compress.lzf.util.LZFFileInputStream
close() - Method in class com.ning.compress.lzf.util.LZFFileOutputStream
com.ning.compress.lzf - package com.ning.compress.lzf
com.ning.compress.lzf.impl - package com.ning.compress.lzf.impl
com.ning.compress.lzf.util - package com.ning.compress.lzf.util
copyTo(byte[], int) - Method in class com.ning.compress.lzf.LZFChunk
copyUpTo32WithSwitch(byte[], int, byte[], int, int) - Static method in class com.ning.compress.lzf.impl.VanillaChunkDecoder
createCompressed(int, byte[], int, int) - Static method in class com.ning.compress.lzf.LZFChunk: Factory method for constructing compressed chunk
createNonCompressed(byte[], int, int) - Static method in class com.ning.compress.lzf.LZFChunk: Factory method for constructing compressed chunk

D

decode(byte[]) - Method in class com.ning.compress.lzf.ChunkDecoder: Method for decompressing a block of input data encoded in LZF block structure (compatible with lzf command line utility), and can consist of any number of blocks.
decode(byte[], int, int) - Method in class com.ning.compress.lzf.ChunkDecoder: Method for decompressing a block of input data encoded in LZF block structure (compatible with lzf command line utility), and can consist of any number of blocks.
decode(byte[], byte[]) - Method in class com.ning.compress.lzf.ChunkDecoder: Method for decompressing a block of input data encoded in LZF block structure (compatible with lzf command line utility), and can consist of any number of blocks.
decode(byte[], int, int, byte[]) - Method in class com.ning.compress.lzf.ChunkDecoder: Method for decompressing a block of input data encoded in LZF block structure (compatible with lzf command line utility), and can consist of any number of blocks.
decode(byte[]) - Static method in class com.ning.compress.lzf.LZFDecoder
decode(byte[], int, int) - Static method in class com.ning.compress.lzf.LZFDecoder
decode(byte[], byte[]) - Static method in class com.ning.compress.lzf.LZFDecoder
decode(byte[], int, int, byte[]) - Static method in class com.ning.compress.lzf.LZFDecoder
decodeChunk(InputStream, byte[], byte[]) - Method in class com.ning.compress.lzf.ChunkDecoder: Main decode from a stream.
decodeChunk(byte[], int, byte[], int, int) - Method in class com.ning.compress.lzf.ChunkDecoder: Main decode method for individual chunks.
decodeChunk(InputStream, byte[], byte[]) - Method in class com.ning.compress.lzf.impl.UnsafeChunkDecoder
decodeChunk(byte[], int, byte[], int, int) - Method in class com.ning.compress.lzf.impl.UnsafeChunkDecoder
decodeChunk(InputStream, byte[], byte[]) - Method in class com.ning.compress.lzf.impl.VanillaChunkDecoder
decodeChunk(byte[], int, byte[], int, int) - Method in class com.ning.compress.lzf.impl.VanillaChunkDecoder
discardBuffered() - Method in class com.ning.compress.lzf.LZFInputStream: Method that can be called to discard any already buffered input, read from input source.

E

encode(byte[]) - Static method in class com.ning.compress.lzf.LZFEncoder
encode(byte[], int) - Static method in class com.ning.compress.lzf.LZFEncoder: Method for compressing given input data using LZF encoding and block structure (compatible with lzf command line utility).
encode(byte[], int, int) - Static method in class com.ning.compress.lzf.LZFEncoder: Method for compressing given input data using LZF encoding and block structure (compatible with lzf command line utility).
encode(ChunkEncoder, byte[], int) - Static method in class com.ning.compress.lzf.LZFEncoder
encode(ChunkEncoder, byte[], int, int) - Static method in class com.ning.compress.lzf.LZFEncoder
encodeAndWriteChunk(byte[], int, int, OutputStream) - Method in class com.ning.compress.lzf.ChunkEncoder: Method for encoding individual chunk, writing it to given output stream.
encodeChunk(byte[], int, int) - Method in class com.ning.compress.lzf.ChunkEncoder: Method for compressing (or not) individual chunks

F

finishBlock() - Method in class com.ning.compress.lzf.LZFOutputStream: Method that can be used to force completion of the current block, which means that all buffered data will be compressed into an LZF block.
finishBlock() - Method in class com.ning.compress.lzf.util.LZFFileOutputStream: Method that can be used to force completion of the current block, which means that all buffered data will be compressed into an LZF block.
flush() - Method in class com.ning.compress.lzf.LZFOutputStream
flush() - Method in class com.ning.compress.lzf.util.LZFFileOutputStream

G

getData() - Method in class com.ning.compress.lzf.LZFChunk
getFinishBlockOnFlush() - Method in class com.ning.compress.lzf.LZFOutputStream: Accessor for checking whether call to "flush()" will first finish the current block or not
getFinishBlockOnFlush() - Method in class com.ning.compress.lzf.util.LZFFileOutputStream: Accessor for checking whether call to "flush()" will first finish the current block or not
getUnderlyingInputStream() - Method in class com.ning.compress.lzf.LZFInputStream: Method that can be used to find underlying InputStream that we read from to get LZF encoded data to decode.
getUnderlyingOutputStream() - Method in class com.ning.compress.lzf.LZFOutputStream: Method that can be used to find underlying OutputStream that we write encoded LZF encoded data into, after compressing it.

H

HEADER_BYTES - Static variable in class com.ning.compress.lzf.ChunkDecoder

I

inputStream - Variable in class com.ning.compress.lzf.LZFInputStream: stream to be decompressed
inputStreamClosed - Variable in class com.ning.compress.lzf.LZFInputStream: Flag that indicates if we have already called 'inputStream.close()' (to avoid calling it multiple times)
instance() - Static method in class com.ning.compress.lzf.BufferRecycler: Accessor to get thread-local recycler instance

L

length() - Method in class com.ning.compress.lzf.LZFChunk
LZF - Class in com.ning.compress.lzf: Simple command-line utility that can be used for testing LZF compression, or as rudimentary command-line tool.
LZF() - Constructor for class com.ning.compress.lzf.LZF
LZFChunk - Class in com.ning.compress.lzf: Helper class used to store LZF encoded segments (compressed and non-compressed) that can be sequenced to produce LZF files/streams.
LZFDecoder - Class in com.ning.compress.lzf: Decoder that handles decoding of sequence of encoded LZF chunks, combining them into a single contiguous result byte array.
LZFDecoder() - Constructor for class com.ning.compress.lzf.LZFDecoder
LZFEncoder - Class in com.ning.compress.lzf: Encoder that handles splitting of input into chunks to encode, calls ChunkEncoder to compress individual chunks and combines resulting chunks into contiguous output byte array.
LZFFileInputStream - Class in com.ning.compress.lzf.util: Helper class that allows use of LZF compression even if a library requires use of FileInputStream.
LZFFileInputStream(File) - Constructor for class com.ning.compress.lzf.util.LZFFileInputStream
LZFFileInputStream(FileDescriptor) - Constructor for class com.ning.compress.lzf.util.LZFFileInputStream
LZFFileInputStream(String) - Constructor for class com.ning.compress.lzf.util.LZFFileInputStream
LZFFileInputStream(File, ChunkDecoder) - Constructor for class com.ning.compress.lzf.util.LZFFileInputStream
LZFFileInputStream(FileDescriptor, ChunkDecoder) - Constructor for class com.ning.compress.lzf.util.LZFFileInputStream
LZFFileInputStream(String, ChunkDecoder) - Constructor for class com.ning.compress.lzf.util.LZFFileInputStream
LZFFileOutputStream - Class in com.ning.compress.lzf.util: Helper class that allows use of LZF compression even if a library requires use of FileOutputStream.
LZFFileOutputStream(File) - Constructor for class com.ning.compress.lzf.util.LZFFileOutputStream
LZFFileOutputStream(File, boolean) - Constructor for class com.ning.compress.lzf.util.LZFFileOutputStream
LZFFileOutputStream(FileDescriptor) - Constructor for class com.ning.compress.lzf.util.LZFFileOutputStream
LZFFileOutputStream(String) - Constructor for class com.ning.compress.lzf.util.LZFFileOutputStream
LZFFileOutputStream(String, boolean) - Constructor for class com.ning.compress.lzf.util.LZFFileOutputStream
LZFInputStream - Class in com.ning.compress.lzf
LZFInputStream(InputStream) - Constructor for class com.ning.compress.lzf.LZFInputStream
LZFInputStream(InputStream, boolean) - Constructor for class com.ning.compress.lzf.LZFInputStream
LZFInputStream(InputStream, boolean, ChunkDecoder) - Constructor for class com.ning.compress.lzf.LZFInputStream
LZFOutputStream - Class in com.ning.compress.lzf: Decorator OutputStream implementation that will compress output using LZF compression algorithm.
LZFOutputStream(OutputStream) - Constructor for class com.ning.compress.lzf.LZFOutputStream

M

main(String[]) - Static method in class com.ning.compress.lzf.LZF
MAX_CHUNK_LEN - Static variable in class com.ning.compress.lzf.LZFChunk
MAX_HEADER_LEN - Static variable in class com.ning.compress.lzf.LZFChunk: Header can be either 7 bytes (compressed) or 5 bytes (uncompressed) long
MAX_LITERAL - Static variable in class com.ning.compress.lzf.LZFChunk: Maximum length of literal run for LZF encoding.

N

next() - Method in class com.ning.compress.lzf.LZFChunk

O

optimalInstance() - Static method in class com.ning.compress.lzf.util.ChunkDecoderFactory: Method to use for getting decompressor instance that uses the most optimal available methods for underlying data access.

P

process(String[]) - Method in class com.ning.compress.lzf.LZF

R

rawWrite(byte[], int, int) - Method in class com.ning.compress.lzf.util.LZFFileOutputStream
read() - Method in class com.ning.compress.lzf.LZFInputStream
read(byte[]) - Method in class com.ning.compress.lzf.LZFInputStream
read(byte[], int, int) - Method in class com.ning.compress.lzf.LZFInputStream
read() - Method in class com.ning.compress.lzf.util.LZFFileInputStream
read(byte[]) - Method in class com.ning.compress.lzf.util.LZFFileInputStream
read(byte[], int, int) - Method in class com.ning.compress.lzf.util.LZFFileInputStream
readFully(InputStream, boolean, byte[], int, int) - Static method in class com.ning.compress.lzf.ChunkDecoder
readHeader(InputStream, byte[]) - Static method in class com.ning.compress.lzf.ChunkDecoder: Helper method to forcibly load header bytes that must be read before chunk can be handled.
readRaw(byte[], int, int) - Method in class com.ning.compress.lzf.util.LZFFileInputStream
readyBuffer() - Method in class com.ning.compress.lzf.LZFInputStream: Fill the uncompressed bytes buffer by reading the underlying inputStream.
readyBuffer() - Method in class com.ning.compress.lzf.util.LZFFileInputStream: Fill the uncompressed bytes buffer by reading the underlying inputStream.
releaseDecodeBuffer(byte[]) - Method in class com.ning.compress.lzf.BufferRecycler
releaseEncodeBuffer(byte[]) - Method in class com.ning.compress.lzf.BufferRecycler
releaseEncodingHash(int[]) - Method in class com.ning.compress.lzf.BufferRecycler
releaseInputBuffer(byte[]) - Method in class com.ning.compress.lzf.BufferRecycler
releaseOutputBuffer(byte[]) - Method in class com.ning.compress.lzf.BufferRecycler

S

safeInstance() - Static method in class com.ning.compress.lzf.util.ChunkDecoderFactory: Method that can be used to ensure that a "safe" decompressor instance is loaded.
setFinishBlockOnFlush(boolean) - Method in class com.ning.compress.lzf.LZFOutputStream: Method for defining whether call to LZFOutputStream.flush() will also complete current block (similar to calling LZFOutputStream.finishBlock()) or not.
setFinishBlockOnFlush(boolean) - Method in class com.ning.compress.lzf.util.LZFFileOutputStream: Method for defining whether call to LZFFileOutputStream.flush() will also complete current block (similar to calling LZFFileOutputStream.finishBlock()) or not.
setNext(LZFChunk) - Method in class com.ning.compress.lzf.LZFChunk
setUseFullReads(boolean) - Method in class com.ning.compress.lzf.LZFInputStream: Method that can be used define whether reads should be "full" or "optimal": former means that full compressed blocks are read right away as needed, optimal that only smaller chunks are read at a time, more being read as needed.
setUseFullReads(boolean) - Method in class com.ning.compress.lzf.util.LZFFileInputStream: Method that can be used define whether reads should be "full" or "optimal": former means that full compressed blocks are read right away as needed, optimal that only smaller chunks are read at a time, more being read as needed.
skip(long) - Method in class com.ning.compress.lzf.LZFInputStream: Overridden to just skip at most a single chunk at a time
skip(long) - Method in class com.ning.compress.lzf.util.LZFFileInputStream: Overridden to just skip at most a single chunk at a time
SUFFIX - Static variable in class com.ning.compress.lzf.LZF

U

uint16(byte[], int) - Static method in class com.ning.compress.lzf.ChunkDecoder
UnsafeChunkDecoder - Class in com.ning.compress.lzf.impl: Highly optimized ChunkDecoder implementation that uses Sun JDK's Unsafe class (which may be included by other JDK's as well; IBM's apparently does).
UnsafeChunkDecoder() - Constructor for class com.ning.compress.lzf.impl.UnsafeChunkDecoder

V

VanillaChunkDecoder - Class in com.ning.compress.lzf.impl: Safe ChunkDecoder implementation that can be used on any platform.
VanillaChunkDecoder() - Constructor for class com.ning.compress.lzf.impl.VanillaChunkDecoder

W

write(int) - Method in class com.ning.compress.lzf.LZFOutputStream
write(byte[], int, int) - Method in class com.ning.compress.lzf.LZFOutputStream
write(byte[]) - Method in class com.ning.compress.lzf.util.LZFFileOutputStream
write(byte[], int, int) - Method in class com.ning.compress.lzf.util.LZFFileOutputStream
write(int) - Method in class com.ning.compress.lzf.util.LZFFileOutputStream
writeCompressedBlock() - Method in class com.ning.compress.lzf.LZFOutputStream: Compress and write the current block to the OutputStream
writeCompressedBlock() - Method in class com.ning.compress.lzf.util.LZFFileOutputStream: Compress and write the current block to the OutputStream
writeCompressedHeader(int, int, OutputStream, byte[]) - Static method in class com.ning.compress.lzf.LZFChunk
writeNonCompressedHeader(int, OutputStream, byte[]) - Static method in class com.ning.compress.lzf.LZFChunk

_

_cfgFinishBlockOnFlush - Variable in class com.ning.compress.lzf.LZFOutputStream: Configuration setting that governs whether basic 'flush()' should first complete a block or not.
_cfgFinishBlockOnFlush - Variable in class com.ning.compress.lzf.util.LZFFileOutputStream: Configuration setting that governs whether basic 'flush()' should first complete a block or not.
_cfgFullReads - Variable in class com.ning.compress.lzf.LZFInputStream: Flag that indicates whether we force full reads (reading of as many bytes as requested), or 'optimal' reads (up to as many as available, but at least one).
_cfgFullReads - Variable in class com.ning.compress.lzf.util.LZFFileInputStream: Flag that indicates whether we force full reads (reading of as many bytes as requested), or 'optimal' reads (up to as many as available, but at least one).
_data - Variable in class com.ning.compress.lzf.LZFChunk
_inputStreamClosed - Variable in class com.ning.compress.lzf.util.LZFFileInputStream: Flag that indicates if we have already called 'inputStream.close()' (to avoid calling it multiple times)
_next - Variable in class com.ning.compress.lzf.LZFChunk
_outputBuffer - Variable in class com.ning.compress.lzf.LZFOutputStream
_outputBuffer - Variable in class com.ning.compress.lzf.util.LZFFileOutputStream
_outputStream - Variable in class com.ning.compress.lzf.LZFOutputStream
_outputStreamClosed - Variable in class com.ning.compress.lzf.LZFOutputStream: Flag that indicates if we have already called '_outputStream.close()' (to avoid calling it multiple times)
_outputStreamClosed - Variable in class com.ning.compress.lzf.util.LZFFileOutputStream: Flag that indicates if we have already called '_outputStream.close()' (to avoid calling it multiple times)
_position - Variable in class com.ning.compress.lzf.LZFOutputStream
_position - Variable in class com.ning.compress.lzf.util.LZFFileOutputStream
_recyclerRef - Static variable in class com.ning.compress.lzf.BufferRecycler: This ThreadLocal contains a SoftReference to a BufferRecycler used to provide a low-cost buffer recycling for buffers we need for encoding, decoding.

A B C D E F G H I L M N O P R S U V W _