ifs.fnd.buffer

Class UTF8ByteCounter

java.lang.Object

ifs.fnd.buffer.UTF8ByteCounter

public class UTF8ByteCounter
extends java.lang.Object

UTF8ByteCounter is used to count the number of UTF-8 bytes in a given string or a character stream. Due to the differences in byte representation when reading invalid surrogate pairs from an input stream and when converting a string to corresponding UTF-8 bytes using String.getBytes("utf-8"), an object of this class must be initialized by providing UTF8ByteCounter.Type.INPUT_STREAM or UTF8ByteCounter.Type.STRING_TO_UTF8 accordingly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UTF8ByteCounter.Type Represents the type of a UTF8ByteCounter object.

Constructor Summary

Constructors

Constructor and Description
UTF8ByteCounter(UTF8ByteCounter.Type type) Initialized a UTF8ByteCounter with the specified type.

Method Summary

Modifier and Type	Method and Description
void	consume(char c) Consumes a character.
static int	count(java.lang.String s) Counts the number of UTF-8 bytes using counting methond UTF8ByteCounter.Type.STRING_TO_UTF8.
static int	count(java.lang.String s, UTF8ByteCounter.Type type) Counts the number of UTF-8 encoded bytes for a given string using the specified counting type.
int	getCount() Returns the number of UTF-8 bytes in the characters consumed.

Methods inherited from class java.lang.Object

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

Constructor Detail

UTF8ByteCounter

public UTF8ByteCounter(UTF8ByteCounter.Type type)

Initialized a UTF8ByteCounter with the specified type.

Parameters:

type - type of the UTF8ByteCounter

Method Detail

count

public static int count(java.lang.String s,
                        UTF8ByteCounter.Type type)

Counts the number of UTF-8 encoded bytes for a given string using the specified counting type.

Parameters:

s - String to be counted

type - Counting method

Returns:

the number of UTF-8 bytes in s.

count

public static int count(java.lang.String s)

Counts the number of UTF-8 bytes using counting methond UTF8ByteCounter.Type.STRING_TO_UTF8. The valued returned is equivalent to s.getBytes("utf-8").

Parameters:

s - String to be counted

Returns:

the number of UTF-8 bytes in s

getCount

public int getCount()

Returns the number of UTF-8 bytes in the characters consumed. If the last character consumed is a high surrogate, it is assumed that it is an invalid surrogate (not in a surrogate pair). Therefore, this method should be used carefully when counting the number of UTF-8 bytes in a character stream, one character at a time.

Returns:

the number of UTF-8 bytes counted so far.

consume

public void consume(char c)

Consumes a character. This method count the UTF-8 bytes considering the characters already consumed.

Parameters:

c - character to be consumed.