com.cloudhopper.commons.charset

Class BaseCharset

java.lang.Object

com.cloudhopper.commons.charset.BaseCharset

All Implemented Interfaces:

Charset

Direct Known Subclasses:

GSMCharset, JavaCharset, ModifiedUTF8Charset

public abstract class BaseCharset
extends Object
implements Charset

Base Charset class implementing common functionality.

Author:

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

Constructor Summary

Constructors

Constructor and Description
BaseCharset()

Method Summary

Methods

Modifier and Type	Method and Description
String	decode(byte[] bytes) Default implementation that simply returns a String by creating a new StringBuffer, appending to it, and then returning a new String.
String	normalize(CharSequence str0) Normalize the characters of the source string to characters that can be represented by this charset.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.cloudhopper.commons.charset.Charset

decode, encode, estimateDecodeCharLength, estimateEncodeByteLength

Constructor Detail

BaseCharset

public BaseCharset()

Method Detail

decode

public String decode(byte[] bytes)

Default implementation that simply returns a String by creating a new StringBuffer, appending to it, and then returning a new String. NOTE: This method is NOT efficient since it requires a double copy of a new String. Some charsets will override this default implementation to provide a more efficient impl.

Specified by:

decode in interface Charset

Parameters:

bytes - The array of bytes to decode

Returns:

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

normalize

public String normalize(CharSequence str0)

Description copied from interface: Charset

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.

Specified by:

normalize in interface Charset

Parameters:

str0 - The source string to normalize

Returns:

The normalized string