com.phloc.commons.charset

Class StringDecoder

java.lang.Object

com.phloc.commons.charset.StringDecoder

@NotThreadSafe
public final class StringDecoder
extends Object

A special string decoder that can be used to convert a byte source to a String in a certain charset. This class is not thread-safe!

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static int	INITIAL_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
StringDecoder(Charset aCharset)

Method Summary

Methods

Modifier and Type	Method and Description
void	decode(byte[] aBuf)
void	decode(byte[] aBuffer, int nOfs, int nLen)
void	decode(ByteBuffer aByteBuffer)
String	finish(byte[] aBuf, int nOfs, int nLen)
String	finish(ByteBuffer aByteBuffer)
void	reserve(int nExpectedLength) Reserve space for the next string that will be <= expectedLength characters long.

Methods inherited from class java.lang.Object

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

Field Detail

INITIAL_BUFFER_SIZE

public static final int INITIAL_BUFFER_SIZE

See Also:

Constant Field Values

Constructor Detail

StringDecoder

public StringDecoder(@Nonnull
             Charset aCharset)

Method Detail

reserve

public void reserve(@Nonnegative
           int nExpectedLength)

Reserve space for the next string that will be <= expectedLength characters long. Must only be called when the buffer is empty.

Parameters:

nExpectedLength - The number of chars to reserve. Must be ≥ 0.

decode

public void decode(@Nonnull
          byte[] aBuf)

decode

public void decode(@Nonnull
          byte[] aBuffer,
          @Nonnegative
          int nOfs,
          @Nonnegative
          int nLen)

decode

public void decode(@Nonnull
          ByteBuffer aByteBuffer)

finish

@Nonnull
public String finish(@Nonnull
                    byte[] aBuf,
                    @Nonnegative
                    int nOfs,
                    @Nonnegative
                    int nLen)

finish

@Nonnull
public String finish(@Nonnull
                    ByteBuffer aByteBuffer)