com.cloudhopper.commons.charset

Interface Charset

All Known Implementing Classes:

AirwideIA5Charset, BaseCharset, GSMCharset, ISO885915Charset, ISO88591Charset, JavaCharset, ModifiedUTF8Charset, PackedGSMCharset, TMobileNlGSMCharset, UCS2Charset, UTF8Charset, VFD2GSMCharset, VFTRGSMCharset

public interface Charset

Interface for any charset.

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Method Summary

Methods

Modifier and Type	Method and Description
String	decode(byte[] bytes) Decode the byte array and return a new Java string.
void	decode(byte[] bytes, StringBuilder buffer) Decode the byte array to a Java string that is appended to the buffer.
byte[]	encode(CharSequence str0) Encode the Java string into a byte array.
int	estimateDecodeCharLength(byte[] bytes)
int	estimateEncodeByteLength(CharSequence str0)
String	normalize(CharSequence str0) Normalize the characters of the source string to characters that can be represented by this charset.

Method Detail

estimateEncodeByteLength

int estimateEncodeByteLength(CharSequence str0)

encode

byte[] encode(CharSequence str0)

Encode the Java string into a byte array.

Parameters:

str0 - The Java string to convert into a byte array

Returns:

A new byte array

estimateDecodeCharLength

int estimateDecodeCharLength(byte[] bytes)

decode

void decode(byte[] bytes,
          StringBuilder buffer)

Decode the byte array to a Java string that is appended to the buffer. Implementations of this method will not change any of the byte values contained in the byte array.

Parameters:

bytes - The array of bytes to decode

buffer - The String buffer to append chars to

decode

String decode(byte[] bytes)

Decode the byte array and return a new Java string. Implementations of this method will not change any of the byte values contained in the byte array.

Parameters:

bytes - The array of bytes to decode

Returns:

A new String with characters decoded from the byte array in the given charset.

normalize

String normalize(CharSequence str0)

Normalize the characters of the source string to characters that can be represented by this charset. Any characters in the input String that cannot be represented by this charset are replaced with a '?' (question mark character).

The default implementation of this method is partially inefficient by first encoding the input String to a byte array representing this charset followed by decoding the byte array back into a Java String. During this double conversion, any characters in the original Java String that don't exist in this charset are replaced with '?' (question mark characters) and then decoded back into a new Java String.

Some charsets may choose to override this default behavior to achieve a more efficient implementation.

Parameters:

str0 - The source string to normalize

Returns:

The normalized string