marytts.util.string

Class ByteStringTranslator

java.lang.Object

marytts.util.string.ByteStringTranslator

public class ByteStringTranslator
extends Object

A helper class converting between a given set of bytes and strings.

Author:

schroed

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAXNUM The maximum number of values that this translator can handle.

Constructor Summary

Constructors

Constructor and Description
ByteStringTranslator() Initialize empty byte-string two-way translator.
ByteStringTranslator(int initialRange) Prepare a ByteStringTranslator to hold the given amount of data.
ByteStringTranslator(String[] strings) Initialize a byte-string two-way translator, setting byte values according to the position of strings in the array.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(byte b) Check if the given (unsigned) byte value is contained in the list.
boolean	contains(String s) Verify if the given string can be translated into a byte by this translator.
String	get(byte b) Look up the (unsigned) byte in this translator.
byte	get(String s) Get the (unsigned) byte value associated to the given string.
int	getNumberOfValues() Give the number of different values in this translator.
String[]	getStringValues()
void	set(byte b, String s) Associate the given (unsigned) byte with the given String.

Methods inherited from class java.lang.Object

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

Field Detail

MAXNUM

public static final int MAXNUM

The maximum number of values that this translator can handle. This is the highest possible number that we can still represent as an unsigned byte.

See Also:

Constant Field Values

Constructor Detail

ByteStringTranslator

public ByteStringTranslator()

Initialize empty byte-string two-way translator.

ByteStringTranslator

public ByteStringTranslator(int initialRange)

Prepare a ByteStringTranslator to hold the given amount of data. After calling this the getNumberOfValues() will still return 0, since there is no actual data yet.

Parameters:

initialRange - the number of values to expect

Throws:

IllegalArgumentException - if initialRange is larger than the maximum number of values, MAXNUM.

ByteStringTranslator

public ByteStringTranslator(String[] strings)

Initialize a byte-string two-way translator, setting byte values according to the position of strings in the array.

Parameters:

strings - a list of up to MAXNUM strings to be represented by unique byte values.

Throws:

IllegalArgumentException - if list of strings is longer than the maximum number of values, MAXNUM.

Method Detail

set

public void set(byte b,
       String s)

Associate the given (unsigned) byte with the given String. Values greater than 127 can be used simply by casting an int to a byte: set((byte)129, "mystring")

Parameters:

b - b

s - s

contains

public boolean contains(String s)

Verify if the given string can be translated into a byte by this translator.

Parameters:

s - s

Returns:

map.containsKey(s)

contains

public boolean contains(byte b)

Check if the given (unsigned) byte value is contained in the list. This supports values between 0 and MAXNUM, cast to byte: contains((byte)129) will indicate if there is a String for the 129'th byte value.

Parameters:

b - b

Returns:

false if index < 0 or index ≥ size of list, true otherwise

get

public byte get(String s)

Get the (unsigned) byte value associated to the given string.

Parameters:

s - s

Returns:

the (unsigned) byte value associated to the given string. To cast this into an integer, use value & 0xFF.

Throws:

IllegalArgumentException - if the string is unknown to the translator.

get

public String get(byte b)

Look up the (unsigned) byte in this translator. This supports values between 0 and MAXNUM, cast to byte: get((byte)129) will get you the 129'th item in the string list.

Parameters:

b - b

Returns:

list.get(index)

getStringValues

public String[] getStringValues()

getNumberOfValues

public int getNumberOfValues()

Give the number of different values in this translator.

Returns:

size of list