Package org.opensearch.index.codec.customcodecs

Class ZstdCodec

java.lang.Object
org.apache.lucene.codecs.Codec
org.apache.lucene.codecs.FilterCodec
org.opensearch.index.codec.customcodecs.ZstdCodec
All Implemented Interfaces:
NamedSPILoader.NamedSPI
public class ZstdCodec extends org.apache.lucene.codecs.FilterCodec
ZstdCodec provides ZSTD compressor using the zstd-jni library.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEFAULT_COMPRESSION_LEVEL
     

    Fields inherited from class org.apache.lucene.codecs.FilterCodec

    delegate

  • Constructor Summary

    Constructors
    Constructor
    Description
    ZstdCodec()
    Creates a new ZstdCodec instance with the default compression level.
    ZstdCodec(int compressionLevel)
    Creates a new ZstdCodec instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.lucene.codecs.StoredFieldsFormat
    storedFieldsFormat()
     
    String
    toString()
    The name for this codec.

    Methods inherited from class org.apache.lucene.codecs.FilterCodec

    compoundFormat, docValuesFormat, fieldInfosFormat, knnVectorsFormat, liveDocsFormat, normsFormat, pointsFormat, postingsFormat, segmentInfoFormat, termVectorsFormat

    Methods inherited from class org.apache.lucene.codecs.Codec

    availableCodecs, forName, getDefault, getName, reloadCodecs, setDefault

    Methods inherited from class java.lang.Object

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

  • Field Details

    • DEFAULT_COMPRESSION_LEVEL

      public static final int DEFAULT_COMPRESSION_LEVEL
      See Also:

  • Constructor Details

    • ZstdCodec

      public ZstdCodec()
      Creates a new ZstdCodec instance with the default compression level.

    • ZstdCodec

      public ZstdCodec(int compressionLevel)
      Creates a new ZstdCodec instance.
      Parameters:
      compressionLevel - The compression level.

  • Method Details

    • toString

      public String toString()
      The name for this codec.

    • storedFieldsFormat

      public org.apache.lucene.codecs.StoredFieldsFormat storedFieldsFormat()
      Overrides:
      storedFieldsFormat in class org.apache.lucene.codecs.FilterCodec