Package org.apache.lucene.codecs.compressing

Class Decompressor

  • All Implemented Interfaces:
    java.lang.Cloneable
    public abstract class Decompressor
extends java.lang.Object
implements java.lang.Cloneable
    A decompressor.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract Decompressor clone()  
      abstract void decompress​(DataInput in, int originalLength, int offset, int length, BytesRef bytes)
      Decompress bytes that were stored between offsets offset and offset+length in the original stream from the compressed stream in to bytes.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • decompress

        public abstract void decompress​(DataInput in,
                                int originalLength,
                                int offset,
                                int length,
                                BytesRef bytes)
                         throws java.io.IOException
        Decompress bytes that were stored between offsets offset and offset+length in the original stream from the compressed stream in to bytes. After returning, the length of bytes (bytes.length) must be equal to length. Implementations of this method are free to resize bytes depending on their needs.
        Parameters:
        in - the input that stores the compressed stream
        originalLength - the length of the original data (before compression)
        offset - bytes before this offset do not need to be decompressed
        length - bytes after offset+length do not need to be decompressed
        bytes - a BytesRef where to store the decompressed data
        Throws:
        java.io.IOException