org.kocakosm.pitaya.charset

Class UTF8

java.lang.Object

org.kocakosm.pitaya.charset.UTF8

public final class UTF8
extends Object

Static utility methods to encode and decode UTF-8 Strings.

Author:

Osman KOCAK

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	canDecode(byte... input) Returns whether the given byte array represents valid UTF-8 encoded characters.
static boolean	canDecode(byte[] input, int off, int len) Returns whether the specified range in the given byte array represents valid UTF-8 encoded characters.
static boolean	canEncode(String str) Returns whether the given String can be encoded into UTF-8.
static boolean	canEncode(String str, int off, int len) Returns whether the specified range in the given String can be encoded into UTF-8.
static String	decode(byte... input) Decodes the given UTF-8 encoded characters.
static String	decode(byte[] input, int off, int len) Decodes len UTF-8 encoded bytes from the given input buffer, starting at off.
static byte[]	encode(String str) Returns the UTF-8 encoding of the given String.
static byte[]	encode(String str, int off, int len) Returns the UTF-8 encoding of the specified character sequence.

Methods inherited from class java.lang.Object

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

Method Detail

canEncode

public static boolean canEncode(String str)

Returns whether the given String can be encoded into UTF-8.

Parameters:

str - the String to test.

Returns:

whether str can be encoded into UTF-8.

Throws:

NullPointerException - if str is null.

canEncode

public static boolean canEncode(String str,
                int off,
                int len)

Returns whether the specified range in the given String can be encoded into UTF-8.

Parameters:

str - the input String.

off - the start index, inclusive.

len - the number of characters to test.

Returns:

whether the specified range in str can be encoded into UTF-8.

Throws:

NullPointerException - if str is null.

IndexOutOfBoundsException - if off or len is negative or if off + len is greater than str's length.

canDecode

public static boolean canDecode(byte... input)

Returns whether the given byte array represents valid UTF-8 encoded characters.

Parameters:

input - the bytes to test.

Returns:

whether input repesents UTF-8 encoded characters.

Throws:

NullPointerException - if input is null.

canDecode

public static boolean canDecode(byte[] input,
                int off,
                int len)

Returns whether the specified range in the given byte array represents valid UTF-8 encoded characters.

Parameters:

input - the input buffer.

off - the start index, inclusive.

len - the number of bytes to test.

Returns:

whether the specified range in input represents UTF-8 encoded characters.

Throws:

NullPointerException - if input is null.

IndexOutOfBoundsException - if off or len is negative or if off + len is greater than input's length.

encode

public static byte[] encode(String str)

Returns the UTF-8 encoding of the given String.

Parameters:

str - the String to encode.

Returns:

the UTF-8 encoding of the given String.

Throws:

NullPointerException - if str is null.

IllegalArgumentException - if str can't be encoded into UTF-8.

encode

public static byte[] encode(String str,
            int off,
            int len)

Returns the UTF-8 encoding of the specified character sequence.

Parameters:

str - the input String.

off - the start index, inclusive.

len - the number of characters to encode.

Returns:

the UTF-8 encoding of the specified characters.

Throws:

NullPointerException - if str is null.

IndexOutOfBoundsException - if off or len is negative or if off + len is greater than str's length.

IllegalArgumentException - if str can't be encoded into UTF-8.

decode

public static String decode(byte... input)

Decodes the given UTF-8 encoded characters.

Parameters:

input - the UTF-8 encoded characters to decode.

Returns:

the decoded characters.

Throws:

NullPointerException - if input is null.

IllegalArgumentException - if input doesn't represent valid UTF-8 encoded characters.

decode

public static String decode(byte[] input,
            int off,
            int len)

Decodes len UTF-8 encoded bytes from the given input buffer, starting at off.

Parameters:

input - the input buffer.

off - the starting offset.

len - the number of bytes to decode.

Returns:

the decoded characters.

Throws:

NullPointerException - if input is null.

IndexOutOfBoundsException - if off or len is negative or if off + len is greater than input's length.

IllegalArgumentException - if input doesn't represent valid UTF-8 encoded characters.