Package com.ibm.as400.access

Class AS400UnsignedBin1

java.lang.Object

com.ibm.as400.access.AS400UnsignedBin1

All Implemented Interfaces:

AS400DataType, Serializable, Cloneable

public class AS400UnsignedBin1
extends Object
implements AS400DataType

Provides a converter between a Short object and an unsigned one-byte binary number. The range of values representable by this data type is 0 through 255 (0x00 through 0xFF).

Note: According to the DDS specification, BINARY() fields occupy a minimum of 2 bytes of storage in IBM i records. Therefore the behavior of this class is not consistent with the semantics of the IBM i BINARY(1) data type. For that reason, this converter is not yet exploited in PCML, RFML, or XPCML.

See Also:

AS400Bin1, Serialized Form

Field Summary

Fields inherited from interface com.ibm.as400.access.AS400DataType

TYPE_ARRAY, TYPE_BIN1, TYPE_BIN2, TYPE_BIN4, TYPE_BIN8, TYPE_BYTE_ARRAY, TYPE_DATE, TYPE_DECFLOAT, TYPE_FLOAT4, TYPE_FLOAT8, TYPE_PACKED, TYPE_STRUCTURE, TYPE_TEXT, TYPE_TIME, TYPE_TIME_OF_DAY, TYPE_TIMESTAMP, TYPE_UBIN1, TYPE_UBIN2, TYPE_UBIN4, TYPE_UBIN8, TYPE_VARCHAR, TYPE_ZONED

Constructor Summary

Constructors

Constructor	Description
AS400UnsignedBin1()	Constructs an AS400UnsignedBin1 object.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Creates a new AS400UnsignedBin1 object that is identical to the current instance.
int	getByteLength()	Returns the byte length of the data type.
Object	getDefaultValue()	Returns a Java object representing the default value of the data type.
int	getInstanceType()	Returns TYPE_UBIN1.
Class	getJavaType()	Returns the Java class that corresponds with this data type.
byte[]	toBytes(short shortValue)	Converts the specified short to IBM i format.
int	toBytes(short shortValue, byte[] as400Value)	Converts the specified short shorto IBM i format in the specified byte array.
int	toBytes(short shortValue, byte[] as400Value, int offset)	Converts the specified short into IBM i format in the specified byte array.
byte[]	toBytes(Object javaValue)	Converts the specified Java object to IBM i format.
int	toBytes(Object javaValue, byte[] as400Value)	Converts the specified Java object into IBM i format in the specified byte array.
int	toBytes(Object javaValue, byte[] as400Value, int offset)	Converts the specified Java object into IBM i format in the specified byte array.
Object	toObject(byte[] as400Value)	Converts the specified IBM i data type to a Java object.
Object	toObject(byte[] as400Value, int offset)	Converts the specified IBM i data type to a Java object.
short	toShort(byte[] as400Value)	Converts the specified IBM i data type to a short.
short	toShort(byte[] as400Value, int offset)	Converts the specified IBM i data type to a short.

Methods inherited from class java.lang.Object

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

Constructor Detail

AS400UnsignedBin1

public AS400UnsignedBin1()

Constructs an AS400UnsignedBin1 object.

Method Detail

clone

public Object clone()

Creates a new AS400UnsignedBin1 object that is identical to the current instance.

Specified by:

clone in interface AS400DataType

Overrides:

clone in class Object

Returns:

The new object.

getByteLength

public int getByteLength()

Returns the byte length of the data type.

Specified by:

getByteLength in interface AS400DataType

Returns:

The number of bytes in the IBM i representation of the data type.

getDefaultValue

public Object getDefaultValue()

Returns a Java object representing the default value of the data type.

Specified by:

getDefaultValue in interface AS400DataType

Returns:

The Short object with a value of zero.

getInstanceType

public int getInstanceType()

Returns TYPE_UBIN1.

Specified by:

getInstanceType in interface AS400DataType

Returns:

AS400DataType.TYPE_UBIN1.

getJavaType

public Class getJavaType()

Returns the Java class that corresponds with this data type.

Specified by:

getJavaType in interface AS400DataType

Returns:

Short.class.

toBytes

public byte[] toBytes(Object javaValue)

Converts the specified Java object to IBM i format.

Specified by:

toBytes in interface AS400DataType

Parameters:

javaValue - The object corresponding to the data type. It must be an instance of Short, and the short must be in the range 0 through 255.

Returns:

The IBM i representation of the data type.

toBytes

public byte[] toBytes(short shortValue)

Converts the specified short to IBM i format.

Parameters:

shortValue - The value to be converted to IBM i format. The short must be greater than or equal to zero and representable in one unsigned byte.

Returns:

The IBM i representation of the data type.

toBytes

public int toBytes(Object javaValue,
                   byte[] as400Value)

Converts the specified Java object into IBM i format in the specified byte array.

Specified by:

toBytes in interface AS400DataType

Parameters:

javaValue - The object corresponding to the data type. It must be an instance of Short, and the short must be in the range 0 through 255.

as400Value - The array to receive the data type in IBM i format. There must be enough space to hold the IBM i value.

Returns:

The number of bytes in the IBM i representation of the data type.

toBytes

public int toBytes(short shortValue,
                   byte[] as400Value)

Converts the specified short shorto IBM i format in the specified byte array.

Parameters:

shortValue - The value to be converted to IBM i format. The short must be greater than or equal to zero and representable in one unsigned byte.

as400Value - The array to receive the data type in IBM i format. There must be enough space to hold the IBM i value.

Returns:

The number of bytes in the IBM i representation of the data type.

toBytes

public int toBytes(Object javaValue,
                   byte[] as400Value,
                   int offset)

Converts the specified Java object into IBM i format in the specified byte array.

Specified by:

toBytes in interface AS400DataType

Parameters:

javaValue - The object corresponding to the data type. It must be an instance of Short, and the short must be in the range 0 through 255.

as400Value - The array to receive the data type in IBM i format. There must be enough space to hold the IBM i value.

offset - The offset into the byte array for the start of the IBM i value. It must be greater than or equal to zero.

Returns:

The number of bytes in the IBM i representation of the data type.

toBytes

public int toBytes(short shortValue,
                   byte[] as400Value,
                   int offset)

Converts the specified short into IBM i format in the specified byte array.

Parameters:

shortValue - The value to be converted to IBM i format. The short must be greater than or equal to zero and representable in one unsigned byte.

as400Value - The array to receive the data type in IBM i format. There must be enough space to hold the IBM i value.

offset - The offset into the byte array for the start of the IBM i value. It must be greater than or equal to zero.

Returns:

The number of bytes in the IBM i representation of the data type.

toObject

public Object toObject(byte[] as400Value)

Converts the specified IBM i data type to a Java object.

Specified by:

toObject in interface AS400DataType

Parameters:

as400Value - The array containing the data type in IBM i format. The entire data type must be represented.

Returns:

A Short object corresponding to the data type.

toObject

public Object toObject(byte[] as400Value,
                       int offset)

Converts the specified IBM i data type to a Java object.

Specified by:

toObject in interface AS400DataType

Parameters:

as400Value - The array containing the data type in IBM i format. The entire data type must be represented.

offset - The offset into the byte array for the start of the IBM i value. It must be greater than or equal to zero.

Returns:

A Short object corresponding to the data type.

toShort

public short toShort(byte[] as400Value)

Converts the specified IBM i data type to a short.

Parameters:

as400Value - The array containing the data type in IBM i format. The entire data type must be represented.

Returns:

The short corresponding to the data type.

toShort

public short toShort(byte[] as400Value,
                     int offset)

Converts the specified IBM i data type to a short.

Parameters:

as400Value - The array containing the data type in IBM i format. The entire data type must be represented.

offset - The offset into the byte array for the start of the IBM i value. It must be greater than or equal to zero.

Returns:

The short corresponding to the data type.