com.ibm.as400.access
Class AS400UnsignedBin4

java.lang.Object
  extended bycom.ibm.as400.access.AS400UnsignedBin4
All Implemented Interfaces:
AS400DataType, Cloneable, Serializable

public class AS400UnsignedBin4
extends Object
implements AS400DataType

The AS400UnsignedBin4 class provides a converter between a Long object and a unsigned four-byte binary number.

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.ibm.as400.access.AS400DataType
TYPE_ARRAY, TYPE_BIN2, TYPE_BIN4, TYPE_BIN8, TYPE_BYTE_ARRAY, TYPE_DECFLOAT, TYPE_FLOAT4, TYPE_FLOAT8, TYPE_PACKED, TYPE_STRUCTURE, TYPE_TEXT, TYPE_UBIN2, TYPE_UBIN4, TYPE_ZONED
 
Constructor Summary
AS400UnsignedBin4()
          Constructs an AS400UnsignedBin4 object.
 
Method Summary
 Object clone()
          Creates a new unsigned, binary-four data type 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_UBIN4.
 Class getJavaType()
          Returns the Java class that corresponds with this data type.
 byte[] toBytes(long longValue)
          Converts the specified long to i5/OS format.
 int toBytes(long longValue, byte[] as400Value)
          Converts the specified long into i5/OS format in the specified byte array.
 int toBytes(long longValue, byte[] as400Value, int offset)
          Converts the specified long into i5/OS format in the specified byte array.
 byte[] toBytes(Object javaValue)
          Converts the specified Java object to i5/OS format.
 int toBytes(Object javaValue, byte[] as400Value)
          Converts the specified Java object into i5/OS format in the specified byte array.
 int toBytes(Object javaValue, byte[] as400Value, int offset)
          Converts the specified Java object into i5/OS format in the specified byte array.
 long toLong(byte[] as400Value)
          Converts the specified i5/OS data type to a long.
 long toLong(byte[] as400Value, int offset)
          Converts the specified i5/OS data type to a long.
 Object toObject(byte[] as400Value)
          Converts the specified i5/OS data type to a Java object.
 Object toObject(byte[] as400Value, int offset)
          Converts the specified i5/OS data type to a Java object.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AS400UnsignedBin4

public AS400UnsignedBin4()
Constructs an AS400UnsignedBin4 object.

Method Detail

clone

public Object clone()
Creates a new unsigned, binary-four data type that is identical to the current instance.

Specified by:
clone in interface AS400DataType
Returns:
The new object.

getByteLength

public int getByteLength()
Returns the byte length of the data type.

Specified by:
getByteLength in interface AS400DataType
Returns:
Four (4), the number of bytes in the i5/OS 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 Long object with a value of zero.

getInstanceType

public int getInstanceType()
Returns TYPE_UBIN4.

Specified by:
getInstanceType in interface AS400DataType
Returns:
AS400DataType.TYPE_UBIN4.

getJavaType

public Class getJavaType()
Returns the Java class that corresponds with this data type.

Specified by:
getJavaType in interface AS400DataType
Returns:
Long.class.

toBytes

public byte[] toBytes(Object javaValue)
Converts the specified Java object to i5/OS format.

Specified by:
toBytes in interface AS400DataType
Parameters:
javaValue - The object corresponding to the data type. It must be an instance of Long, and the long must be greater than or equal to zero and representable in four bytes.
Returns:
The i5/OS representation of the data type.

toBytes

public byte[] toBytes(long longValue)
Converts the specified long to i5/OS format.

Parameters:
longValue - The value to be converted to i5/OS format. The long must be greater than or equal to zero and representable in four bytes.
Returns:
The i5/OS representation of the data type.

toBytes

public int toBytes(Object javaValue,
                   byte[] as400Value)
Converts the specified Java object into i5/OS 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 Long, and the long must be greater than or equal to zero and representable in four bytes.
as400Value - The array to receive the data type in i5/OS format. There must be enough space to hold the i5/OS value.
Returns:
Four (4), the number of bytes in the i5/OS representation of the data type.

toBytes

public int toBytes(long longValue,
                   byte[] as400Value)
Converts the specified long into i5/OS format in the specified byte array.

Parameters:
longValue - The value to be converted to i5/OS format. The long must be greater than or equal to zero and representable in four bytes.
as400Value - The array to receive the data type in i5/OS format. There must be enough space to hold the i5/OS value.
Returns:
Four (4), the number of bytes in the i5/OS representation of the data type.

toBytes

public int toBytes(Object javaValue,
                   byte[] as400Value,
                   int offset)
Converts the specified Java object into i5/OS 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 Long, and the long must be greater than or equal to zero and representable in four bytes.
as400Value - The array to receive the data type in i5/OS format. There must be enough space to hold the i5/OS value.
offset - The offset into the byte array for the start of the i5/OS value. It must be greater than or equal to zero.
Returns:
Four (4), the number of bytes in the i5/OS representation of the data type.

toBytes

public int toBytes(long longValue,
                   byte[] as400Value,
                   int offset)
Converts the specified long into i5/OS format in the specified byte array.

Parameters:
longValue - The value to be converted to i5/OS format. The long must be greater than or equal to zero and representable in four bytes.
as400Value - The array to receive the data type in i5/OS format. There must be enough space to hold the i5/OS value.
offset - The offset into the byte array for the start of the i5/OS value. It must be greater than or equal to zero.
Returns:
Four (4), the number of bytes in the i5/OS representation of the data type.

toLong

public long toLong(byte[] as400Value)
Converts the specified i5/OS data type to a long.

Parameters:
as400Value - The array containing the data type in i5/OS format. The entire data type must be represented.
Returns:
The long corresponding to the data type.

toLong

public long toLong(byte[] as400Value,
                   int offset)
Converts the specified i5/OS data type to a long.

Parameters:
as400Value - The array containing the data type in i5/OS format. The entire data type must be represented.
offset - The offset into the byte array for the start of the i5/OS value. It must be greater than or equal to zero.
Returns:
The long corresponding to the data type.

toObject

public Object toObject(byte[] as400Value)
Converts the specified i5/OS data type to a Java object.

Specified by:
toObject in interface AS400DataType
Parameters:
as400Value - The array containing the data type in i5/OS format. The entire data type must be represented.
Returns:
The Long object corresponding to the data type.

toObject

public Object toObject(byte[] as400Value,
                       int offset)
Converts the specified i5/OS data type to a Java object.

Specified by:
toObject in interface AS400DataType
Parameters:
as400Value - The array containing the data type in i5/OS format. The entire data type must be represented.
offset - The offset into the byte array for the start of the i5/OS value. It must be greater than or equal to zero.
Returns:
The Long object corresponding to the data type.