net.sf.rubycollect4j.util

Class ASCII8BitUTF

java.lang.Object

net.sf.rubycollect4j.util.ASCII8BitUTF

All Implemented Interfaces:

java.lang.CharSequence

public final class ASCII8BitUTF
extends java.lang.Object
implements java.lang.CharSequence

ASCII8BitUTF traverse a String byte by byte. It uses ACII8Bit to encode String characters which have codepoints between 0-255 into single byte and remains other String characters as UTF8 encoding.

It is designed for RubyString.unpack(java.lang.String) to use.

Constructor Summary

Constructors

Constructor and Description
ASCII8BitUTF(java.lang.String str) Returns a ASCII8BitUTF.

Method Summary

Methods

Modifier and Type	Method and Description
char	charAt(int index)
boolean	equals(java.lang.Object o)
int	hashCode()
boolean	hasNextByte() Checks if there are remaining bytes.
boolean	hasNextChar() Checks if there are remaining characters.
int	length()
byte	nextByte() Returns next byte.
byte[]	nextByte(int n) Returns next n as maximum bytes.
java.lang.String	nextChar() Returns next character.
java.lang.String	nextChar(int n) Returns next n as maximum chars.
int	remainingByteNumber() Returns the remaining number of bytes.
void	rewind() Rewinds this ASCII8BitUTF.
java.lang.CharSequence	subSequence(int start, int end)
java.lang.String	toString()
int	totalByteNumber() Returns the total number of bytes.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ASCII8BitUTF

public ASCII8BitUTF(java.lang.String str)

Returns a ASCII8BitUTF.

Parameters:

str - any String

Method Detail

totalByteNumber

public int totalByteNumber()

Returns the total number of bytes.

Returns:

the total number of bytes

remainingByteNumber

public int remainingByteNumber()

Returns the remaining number of bytes.

Returns:

the remaining number of bytes

rewind

public void rewind()

Rewinds this ASCII8BitUTF.

hasNextChar

public boolean hasNextChar()

Checks if there are remaining characters.

Returns:

true if there are remaining characters, false otherwise

hasNextByte

public boolean hasNextByte()

Checks if there are remaining bytes.

Returns:

true if there are remaining bytes, false otherwise

nextChar

public java.lang.String nextChar()

Returns next character.

Returns:

character as String

Throws:

java.lang.IllegalStateException - if no more character is left

nextChar

public java.lang.String nextChar(int n)

Returns next n as maximum chars.

Parameters:

n - maximum number of chars

Returns:

String

nextByte

public byte nextByte()

Returns next byte.

Returns:

byte

Throws:

java.lang.IllegalStateException - if no more byte is left

nextByte

public byte[] nextByte(int n)

Returns next n as maximum bytes.

Parameters:

n - maximum number of bytes

Returns:

byte array

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Specified by:

toString in interface java.lang.CharSequence

Overrides:

toString in class java.lang.Object

charAt

public char charAt(int index)

Specified by:

charAt in interface java.lang.CharSequence

length

public int length()

Specified by:

length in interface java.lang.CharSequence

subSequence

public java.lang.CharSequence subSequence(int start,
                                 int end)

Specified by:

subSequence in interface java.lang.CharSequence