com.ibm.ims.dli.converters

Interface StringTypeConverter

public interface StringTypeConverter

The StringTypeConverter interface is a converter for the Java String data type.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getString(byte[] ioArea, int start, int length, java.util.Collection<java.lang.String> warningStrings) Retrieves the designated string value from the input/output byte array.
void	setString(byte[] ioArea, int start, int length, java.lang.String object, java.util.Collection<java.lang.String> warningStrings) Sets the designated string value into the input/output byte array.

Method Detail

getString

java.lang.String getString(byte[] ioArea,
                           int start,
                           int length,
                           java.util.Collection<java.lang.String> warningStrings)
                    throws com.ibm.ims.dli.types.ConversionException

Retrieves the designated string value from the input/output byte array.

Parameters:

ioArea - The input/output byte array to be read from

start - The starting offset in the input/output byte array to read from

length - The number of bytes that will be read from the input/output byte array

warningStrings - The associated warnings for the conversion

Returns:

the string value associated to the bytes in the input/output area

Throws:

com.ibm.ims.dli.types.ConversionException - if the bytes could not be converted to a string

setString

void setString(byte[] ioArea,
               int start,
               int length,
               java.lang.String object,
               java.util.Collection<java.lang.String> warningStrings)
        throws com.ibm.ims.dli.types.ConversionException

Sets the designated string value into the input/output byte array.

Parameters:

ioArea - The input/output byte array to be written to

start - The starting offset in the input/output byte array to write to

length - The number of bytes that will be written in the input/output byte array

object - The value of the string

warningStrings - The associated warnings for the conversion

Throws:

com.ibm.ims.dli.types.ConversionException - if the string value could not be converted to bytes