 |
Lucene.Net
3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
|
|
Lucene.Net
3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
|
Provides support for converting byte sequences to Strings and back again. The resulting Strings preserve the original byte sequences' sort order. More...
Classes | |
| class | CodingCase |
Static Public Member Functions | |
| static int | GetEncodedLength (System.Collections.Generic.List< byte > original) |
| Returns the number of chars required to encode the given byte sequence. | |
| static int | GetDecodedLength (System.Collections.Generic.List< char > encoded) |
| Returns the number of bytes required to decode the given char sequence. | |
| static void | Encode (System.Collections.Generic.List< byte > input, System.Collections.Generic.List< char > output) |
| Encodes the input byte sequence into the output char sequence. Before calling this method, ensure that the output CharBuffer has sufficient capacity by calling GetEncodedLength(System.Collections.Generic.List{byte}). | |
| static void | Decode (System.Collections.Generic.List< char > input, System.Collections.Generic.List< byte > output) |
| Decodes the input char sequence into the output byte sequence. Before calling this method, ensure that the output ByteBuffer has sufficient capacity by calling GetDecodedLength(System.Collections.Generic.List{char}). | |
| static System.Collections.Generic.List < byte > | Decode (System.Collections.Generic.List< char > input) |
| Decodes the given char sequence, which must have been encoded by Encode(System.Collections.Generic.List{byte}) or Encode(System.Collections.Generic.List{byte}, System.Collections.Generic.List{char}). | |
| static System.Collections.Generic.List < char > | Encode (System.Collections.Generic.List< byte > input) |
| Encodes the input byte sequence. | |
Provides support for converting byte sequences to Strings and back again. The resulting Strings preserve the original byte sequences' sort order.
The Strings are constructed using a Base 8000h encoding of the original binary data - each char of an encoded String represents a 15-bit chunk from the byte sequence. Base 8000h was chosen because it allows for all lower 15 bits of char to be used without restriction; the surrogate range [U+D8000-U+DFFF] does not represent valid chars, and would require complicated handling to avoid them and allow use of char's high bit.
Although unset bits are used as padding in the final char, the original byte sequence could contain trailing bytes with no set bits (null bytes): padding is indistinguishable from valid information. To overcome this problem, a char is appended, indicating the number of encoded bytes in the final content char.
This class's operations are defined over CharBuffers and ByteBuffers, to allow for wrapped arrays to be reused, reducing memory allocation costs for repeated operations. Note that this class calls array() and arrayOffset() on the CharBuffers and ByteBuffers it uses, so only wrapped arrays may be used. This class interprets the arrayOffset() and limit() values returned by its input buffers as beginning and end+1 positions on the wrapped array, resprectively; similarly, on the output buffer, arrayOffset() is the first position written to, and limit() is set to one past the final output array position.
Definition at line 54 of file IndexableBinaryStringTools.cs.
|
static |
Decodes the input char sequence into the output byte sequence. Before calling this method, ensure that the output ByteBuffer has sufficient capacity by calling GetDecodedLength(System.Collections.Generic.List{char}).
| input | The char sequence to decode |
| output | Where the byte sequence decoding result will go. The limit is set to one past the position of the final char. |
<throws> IllegalArgumentException If either the input or the output buffer </throws>
is not backed by an array
Definition at line 193 of file IndexableBinaryStringTools.cs.
|
static |
Decodes the given char sequence, which must have been encoded by Encode(System.Collections.Generic.List{byte}) or Encode(System.Collections.Generic.List{byte}, System.Collections.Generic.List{char}).
| input | The char sequence to decode |
<throws> IllegalArgumentException If the input buffer is not backed by an </throws>
array
Definition at line 287 of file IndexableBinaryStringTools.cs.
|
static |
Encodes the input byte sequence into the output char sequence. Before calling this method, ensure that the output CharBuffer has sufficient capacity by calling GetEncodedLength(System.Collections.Generic.List{byte}).
| input | The byte sequence to encode |
| output | Where the char sequence encoding result will go. The limit is set to one past the position of the final char. |
<throws> IllegalArgumentException If either the input or the output buffer </throws>
is not backed by an array
Definition at line 113 of file IndexableBinaryStringTools.cs.
|
static |
Encodes the input byte sequence.
| input | The byte sequence to encode |
<throws> IllegalArgumentException If the input buffer is not backed by an </throws>
array
Definition at line 306 of file IndexableBinaryStringTools.cs.
|
static |
Returns the number of bytes required to decode the given char sequence.
| encoded | The char sequence to be encoded. Must be backed by an array. |
<throws> IllegalArgumentException If the given CharBuffer is not backed by an array </throws>
Definition at line 85 of file IndexableBinaryStringTools.cs.
|
static |
Returns the number of chars required to encode the given byte sequence.
| original | The byte sequence to be encoded. Must be backed by an array. |
<throws> IllegalArgumentException If the given ByteBuffer is not backed by an array </throws>
Definition at line 72 of file IndexableBinaryStringTools.cs.
1.8.3
