com.helger.commons.charset

Class StringEncoder

java.lang.Object

com.helger.commons.charset.StringEncoder

@NotThreadSafe
public final class StringEncoder
extends Object

A special string encoder that can be used to convert a set of characters/string to a byte sequence in a certain charset. This class is not thread-safe!

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static int	BYTE_BUFFER_SIZE
static int	CHAR_BUFFER_SIZE
static int	UTF8_MAX_BYTES_PER_CHAR

Constructor Summary

Constructors

Constructor and Description
StringEncoder(Charset aCharset)

Method Summary

Modifier and Type	Method and Description
EFinish	encode(String sSource, ByteBuffer aDestBuffer) Encodes string into destination.
byte[]	getAsNewArray(String sSource) Returns a new byte array containing the UTF-8 version of source.
ByteBuffer	getAsNewByteBuffer(String sSource) Returns a ByteBuffer containing the encoded version of source.
void	reset()

Methods inherited from class java.lang.Object

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

Field Detail

CHAR_BUFFER_SIZE

public static final int CHAR_BUFFER_SIZE

See Also:

Constant Field Values

BYTE_BUFFER_SIZE

public static final int BYTE_BUFFER_SIZE

See Also:

Constant Field Values

UTF8_MAX_BYTES_PER_CHAR

public static final int UTF8_MAX_BYTES_PER_CHAR

See Also:

Constant Field Values

Constructor Detail

StringEncoder

public StringEncoder(@Nonnull
                     Charset aCharset)

Method Detail

encode

@Nonnull
public EFinish encode(@Nonnull
                                String sSource,
                                @Nonnull
                                ByteBuffer aDestBuffer)

Encodes string into destination. This must be called multiple times with the same string until it returns true. When this returns false, it must be called again with larger destination buffer space. It is possible that there are a few bytes of space remaining in the destination buffer, even though it must be refreshed. For example, if a UTF-8 3 byte sequence needs to be written, but there is only 1 or 2 bytes of space, this will leave the last couple bytes unused.

Parameters:

sSource - Source string

aDestBuffer - a ByteBuffer that will be filled with data.

Returns:

EFinish

getAsNewByteBuffer

@Nonnull
public ByteBuffer getAsNewByteBuffer(@Nonnull
                                               String sSource)

Returns a ByteBuffer containing the encoded version of source. The position of the ByteBuffer will be 0, the limit is the length of the string. The capacity of the ByteBuffer may be larger than the string.

Parameters:

sSource - Source string

Returns:

The new byte buffer

getAsNewArray

@Nonnull
 @ReturnsMutableCopy
public byte[] getAsNewArray(@Nonnull
                                                            String sSource)

Returns a new byte array containing the UTF-8 version of source. The array will be exactly the correct size for the string.

Parameters:

sSource - Source string

Returns:

as encoded array

reset

public void reset()