Class CompressionTools

Simple utility class providing static methods to compress and decompress binary data for stored fields. this class uses the class to compress and decompress.

Inheritance
System.Object
CompressionTools
Namespace: Lucene.Net.Documents
Assembly: Lucene.Net.dll
Syntax
public class CompressionTools : object

Methods

| Improve this Doc View Source

Compress(Byte[])

Compresses all s in the array, with default level

Declaration
public static byte[] Compress(byte[] value)
Parameters
Type Name Description
System.Byte[] value
Returns
Type Description
System.Byte[]
| Improve this Doc View Source

Compress(Byte[], Int32, Int32)

Compresses the specified range, with default level

Declaration
public static byte[] Compress(byte[] value, int offset, int length)
Parameters
Type Name Description
System.Byte[] value
System.Int32 offset
System.Int32 length
Returns
Type Description
System.Byte[]
| Improve this Doc View Source

Compress(Byte[], Int32, Int32, CompressionLevel)

Compresses the specified range using the specified compressionLevel.

Declaration
public static byte[] Compress(byte[] value, int offset, int length, CompressionLevel compressionLevel)
Parameters
Type Name Description
System.Byte[] value
System.Int32 offset
System.Int32 length
CompressionLevel compressionLevel
Returns
Type Description
System.Byte[]
| Improve this Doc View Source

CompressString(String)

Compresses the value, with default level

Declaration
public static byte[] CompressString(string value)
Parameters
Type Name Description
System.String value
Returns
Type Description
System.Byte[]
| Improve this Doc View Source

CompressString(String, CompressionLevel)

Compresses the value using the specified compressionLevel.

Declaration
public static byte[] CompressString(string value, CompressionLevel compressionLevel)
Parameters
Type Name Description
System.String value
CompressionLevel compressionLevel
Returns
Type Description
System.Byte[]
| Improve this Doc View Source

Decompress(BytesRef)

Decompress the array previously returned by compress (referenced by the provided BytesRef)

Declaration
public static byte[] Decompress(BytesRef bytes)
Parameters
Type Name Description
BytesRef bytes
Returns
Type Description
System.Byte[]
| Improve this Doc View Source

Decompress(Byte[])

Decompress the array previously returned by compress

Declaration
public static byte[] Decompress(byte[] value)
Parameters
Type Name Description
System.Byte[] value
Returns
Type Description
System.Byte[]
| Improve this Doc View Source

Decompress(Byte[], Int32, Int32)

Decompress the array previously returned by compress

Declaration
public static byte[] Decompress(byte[] value, int offset, int length)
Parameters
Type Name Description
System.Byte[] value
System.Int32 offset
System.Int32 length
Returns
Type Description
System.Byte[]
| Improve this Doc View Source

DecompressString(BytesRef)

Decompress the array (referenced by the provided BytesRef) previously returned by CompressString(String) back into a

Declaration
public static string DecompressString(BytesRef bytes)
Parameters
Type Name Description
BytesRef bytes
Returns
Type Description
System.String
| Improve this Doc View Source

DecompressString(Byte[])

Decompress the array previously returned by CompressString(String) back into a

Declaration
public static string DecompressString(byte[] value)
Parameters
Type Name Description
System.Byte[] value
Returns
Type Description
System.String
| Improve this Doc View Source

DecompressString(Byte[], Int32, Int32)

Decompress the array previously returned by CompressString(String) back into a

Declaration
public static string DecompressString(byte[] value, int offset, int length)
Parameters
Type Name Description
System.Byte[] value
System.Int32 offset
System.Int32 length
Returns
Type Description
System.String