com.oracle.objectfile.io

Class Utf8

java.lang.Object

com.oracle.objectfile.io.Utf8

public final class Utf8
extends Object

Implements UTF-8 encoding and decoding of strings with support for zero-bytes as string terminators.

Method Summary

Modifier and Type	Method and Description
static void	substringToUtf8(ByteBuffer dest, String source, int beginIndex, int endIndex, boolean zeroTerminate) Writes an UTF8-encoded string region to a given byte buffer.
static int	utf8Length(String string)
static int	utf8Length(String s, int beginIndex, int endIndex)
static String	utf8ToString(boolean zeroTerminated, ByteBuffer source) Converts a byte buffer of UTF-8 data to a String.

Methods inherited from class java.lang.Object

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

Method Detail

utf8Length

public static int utf8Length(String string)

Returns:

the length in bytes of the UTF8 representation of the string

utf8Length

public static int utf8Length(String s,
                             int beginIndex,
                             int endIndex)

Parameters:

beginIndex - first index that is part of the region, inclusive

endIndex - index at the end of the region, exclusive

Returns:

the length in bytes of the UTF8 representation of the string region

substringToUtf8

public static void substringToUtf8(ByteBuffer dest,
                                   String source,
                                   int beginIndex,
                                   int endIndex,
                                   boolean zeroTerminate)

Writes an UTF8-encoded string region to a given byte buffer.

Parameters:

dest - the byte buffer to write to

source - the String to be written

beginIndex - first index in source that is part of the region, inclusive

endIndex - index in source at the end of the region, exclusive

zeroTerminate - whether to write a final zero byte

utf8ToString

public static String utf8ToString(boolean zeroTerminated,
                                  ByteBuffer source)
                           throws CharConversionException

Converts a byte buffer of UTF-8 data to a String. The entire buffer until the buffer's limit is converted unless zeroTerminated is true, in which case conversion stops at the first zero byte.

Parameters:

zeroTerminated - if true, then a 0 byte marks the end of the string, and character '\0' in the input must be encoded as two bytes as opposed to one

source - the byte buffer to read from

Returns:

the decoded string

Throws:

CharConversionException