Class CompressionTools

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

Inheritance

System.Object

CompressionTools

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Lucene.Net.Documents

Assembly: Lucene.Net.dll

Syntax

public static class CompressionTools

Methods

| Improve this Doc View Source

Compress(Byte[])

Compresses all System.Bytes in the array, with default System.IO.Compression.CompressionLevel.Optimal 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 System.Byte range, with default System.IO.Compression.CompressionLevel.Optimal 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 System.Byte 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
System.IO.Compression.CompressionLevel	compressionLevel

Returns

Type	Description
System.Byte[]

| Improve this Doc View Source

CompressString(String)

Compresses the System.String value, with default System.IO.Compression.CompressionLevel.Optimal 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 System.String value using the specified compressionLevel.

Declaration

public static byte[] CompressString(string value, CompressionLevel compressionLevel)

Parameters

Type	Name	Description
System.String	value
System.IO.Compression.CompressionLevel	compressionLevel

Returns

Type	Description
System.Byte[]

| Improve this Doc View Source

Decompress(BytesRef)

Decompress the System.Byte 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 System.Byte 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 System.Byte 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 System.Byte array (referenced by the provided BytesRef) previously returned by CompressString(String) back into a System.String

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 System.Byte array previously returned by CompressString(String) back into a System.String

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 System.Byte array previously returned by CompressString(String) back into a System.String

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