Module org.apache.lucene.backward_codecs

Package org.apache.lucene.backward_codecs.compressing

Class Compressor

java.lang.Object

org.apache.lucene.backward_codecs.compressing.Compressor

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

CompressionMode.DeflateCompressor, CompressionMode.LZ4FastCompressor, CompressionMode.LZ4HighCompressor, DeflateWithPresetDictCompressionMode.DeflateWithPresetDictCompressor, Lucene50StoredFieldsFormat.LZ4FastCompressor, LZ4WithPresetDictCompressionMode.LZ4WithPresetDictCompressor

public abstract class Compressor
extends Object
implements Closeable

A data compressor.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Compressor()	Sole constructor, typically called from sub-classes.

Method Summary

Modifier and Type	Method	Description
abstract void	compress(byte[] bytes, int off, int len, DataOutput out)	Compress bytes into out.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Details

Compressor

protected Compressor()

Sole constructor, typically called from sub-classes.

Method Details

compress

public abstract void compress(byte[] bytes,
 int off,
 int len,
 DataOutput out)
                       throws IOException

Compress bytes into out. It is the responsibility of the compressor to add all necessary information so that a Decompressor will know when to stop decompressing bytes from the stream.

Throws:

IOException