com.tivoli.twg.libs
Class TWGNLSString

java.lang.Object
  extended bycom.tivoli.twg.libs.TWGNLSString
All Implemented Interfaces:
DataValue

public class TWGNLSString
extends java.lang.Object
implements DataValue

Sendable NLS string object, based on DataValue interface. Specifies a pair of strings: an NLS bundle class plus a string ID, and is used to communicate references to translated strings. These are intended for use when data needs to be communicated to and from both Java and non-Java code.


Field Summary
 
Fields inherited from interface com.tivoli.twg.libs.DataValue
BOOLEAN_ARRAY_TYPE, BOOLEAN_TYPE, BYTE_ARRAY_TYPE, BYTE_TYPE, DATE_TYPE, DOUBLE_ARRAY_TYPE, DOUBLE_TYPE, FLOAT_ARRAY_TYPE, FLOAT_TYPE, FORMATTED_STRING_TYPE, INTEGER_ARRAY_TYPE, INTEGER_TYPE, LOCALESPECSTRING_TYPE, LONG_ARRAY_TYPE, LONG_TYPE, NLSSTRING_TYPE, NONE_TYPE, SHORT_ARRAY_TYPE, SHORT_TYPE, STRING_ARRAY_TYPE, STRING_TYPE
 
Constructor Summary
TWGNLSString()
          Default constructor : null string
TWGNLSString(java.lang.String v, java.lang.String nls)
          Construct with initial value
 
Method Summary
 int getDataValueType()
          Get DataValue type
 java.lang.String getNLSBundle()
          Get current NLS bundle ID
 java.lang.String getStringID()
          Get current string ID
 int readDataValue(byte[] buf, int start)
          Read value from byte array into object
 void setValue(java.lang.String v, java.lang.String nls)
          Set new value
 java.lang.String toNLSString(java.util.Locale loc)
          Get value as string for given locale
 java.lang.String toString()
          Get value as string
 java.lang.String toString(java.util.Locale loc)
          Get value as string for given locale
 int writeDataValue(byte[] buf, int start)
          Write value into byte array : used for sending data value
 int writeDataValueLength()
          Get length needed to write value into byte array : used for sending data value
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TWGNLSString

public TWGNLSString()
Default constructor : null string


TWGNLSString

public TWGNLSString(java.lang.String v,
                    java.lang.String nls)
Construct with initial value

Parameters:
v - - value of string ID
nls - - name of NLS ResourceBundle class containing string
Method Detail

toString

public java.lang.String toString()
Get value as string


toString

public java.lang.String toString(java.util.Locale loc)
Get value as string for given locale

Parameters:
loc - - locale requested

toNLSString

public java.lang.String toNLSString(java.util.Locale loc)
Get value as string for given locale

Specified by:
toNLSString in interface DataValue
Parameters:
loc - - locale requested

setValue

public void setValue(java.lang.String v,
                     java.lang.String nls)
Set new value

Parameters:
v - - new value
nls - - new NLS bundle value

getStringID

public java.lang.String getStringID()
Get current string ID

Returns:
current string ID

getNLSBundle

public java.lang.String getNLSBundle()
Get current NLS bundle ID

Returns:
NLS bundle ID

writeDataValue

public int writeDataValue(byte[] buf,
                          int start)
Write value into byte array : used for sending data value

Specified by:
writeDataValue in interface DataValue
Parameters:
buf - - buffer to write data into
start - - starting index for data write in 'buf'
Returns:
index of byte after last byte writted to 'buf'

writeDataValueLength

public int writeDataValueLength()
Get length needed to write value into byte array : used for sending data value

Specified by:
writeDataValueLength in interface DataValue
Returns:
bytes needed

readDataValue

public int readDataValue(byte[] buf,
                         int start)
Read value from byte array into object

Specified by:
readDataValue in interface DataValue
Parameters:
buf - - buffer to read from
start - - index of start of data to be read
Returns:
index of byte after last byte read

getDataValueType

public int getDataValueType()
Get DataValue type

Specified by:
getDataValueType in interface DataValue
Returns:
type code for DataValue subclass