com.allanbank.mongodb.bson.io

Class StringDecoder

java.lang.Object

com.allanbank.mongodb.bson.io.StringDecoder

public class StringDecoder
extends Object

StringDecoder provides a decoder for byte arrays into strings that uses a trie data structure to cache recurring strings.

This class is not thread safe.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2013, Allanbank Consulting, Inc., All Rights Reserved

Constructor Summary

Constructors

Constructor and Description
StringDecoder() Creates a new StringDecoder.
StringDecoder(StringDecoderCache cache) Creates a new StringDecoder.

Method Summary

Methods

Modifier and Type	Method and Description
String	decode(byte[] source, int offset, int length) Decode a string of a known length.
StringDecoderCache	getCache() Deprecated. The cache StringDecoderCache should be controlled directly. This method will be removed after the 2.1.0 release.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringDecoder

public StringDecoder()

Creates a new StringDecoder.

StringDecoder

public StringDecoder(StringDecoderCache cache)

Creates a new StringDecoder.

Parameters:

cache - The cache for the decoder.

Method Detail

decode

public String decode(byte[] source,
            int offset,
            int length)
              throws StreamCorruptedException,
                     EOFException

Decode a string of a known length. The last byte should be a zero byte and will not be included in the decoded string.

Parameters:

source - The source of the bytes in the string.

offset - The offset of the first byte to decode.

length - The length of the string to decode with a terminal zero byte.

Returns:

The decoded string.

Throws:

StreamCorruptedException - On the decoding of the string failing.

EOFException - On the array not containing enough bytes to decoded.

getCache

@Deprecated
public StringDecoderCache getCache()

Deprecated. The cache StringDecoderCache should be controlled directly. This method will be removed after the 2.1.0 release.

Returns the cache value.

Returns:

The cache value.