com.ibm.as400.access
Class AS400UnsignedBin4

java.lang.Object
  |
  +--com.ibm.as400.access.AS400UnsignedBin4
All Implemented Interfaces:
AS400DataType, java.lang.Cloneable, java.io.Serializable

public class AS400UnsignedBin4
extends java.lang.Object
implements AS400DataType

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

See Also:
Serialized Form

Fields inherited from interface com.ibm.as400.access.AS400DataType
serialVersionUID
 
Constructor Summary
AS400UnsignedBin4()
          Constructs an AS400UnsignedBin4 object.
 
Method Summary
 java.lang.Object clone()
          Creates a new AS/400 unsigned, binary-four data type that is identical to the current instance.
 int getByteLength()
          Returns the byte length of the data type.
 java.lang.Object getDefaultValue()
          Returns a Java object representing the default value of the data type.
 byte[] toBytes(long longValue)
          Converts the specified long to AS/400 format.
 int toBytes(long longValue, byte[] as400Value)
          Converts the specified long into AS/400 format in the specified byte array.
 int toBytes(long longValue, byte[] as400Value, int offset)
          Converts the specified long into AS/400 format in the specified byte array.
 byte[] toBytes(java.lang.Object javaValue)
          Converts the specified Java object to AS/400 format.
 int toBytes(java.lang.Object javaValue, byte[] as400Value)
          Converts the specified Java object into AS/400 format in the specified byte array.
 int toBytes(java.lang.Object javaValue, byte[] as400Value, int offset)
          Converts the specified Java object into AS/400 format in the specified byte array.
 long toLong(byte[] as400Value)
          Converts the specified AS/400 data type to a long.
 long toLong(byte[] as400Value, int offset)
          Converts the specified AS/400 data type to a long.
 java.lang.Object toObject(byte[] as400Value)
          Converts the specified AS/400 data type to a Java object.
 java.lang.Object toObject(byte[] as400Value, int offset)
          Converts the specified AS/400 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 java.lang.Object clone()
Creates a new AS/400 unsigned, binary-four data type that is identical to the current instance.
Specified by:
clone in interface AS400DataType
Overrides:
clone in class java.lang.Object
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 AS/400 representation of the data type.

getDefaultValue

public java.lang.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.

toBytes

public byte[] toBytes(java.lang.Object javaValue)
Converts the specified Java object to AS/400 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 AS/400 representation of the data type.

toBytes

public byte[] toBytes(long longValue)
Converts the specified long to AS/400 format.
Parameters:
longValue - The value to be converted to AS/400 format. The long must be greater than or equal to zero and representable in four bytes.
Returns:
The AS/400 representation of the data type.

toBytes

public int toBytes(java.lang.Object javaValue,
                   byte[] as400Value)
Converts the specified Java object into AS/400 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 AS/400 format. There must be enough space to hold the AS/400 value.
Returns:
Four (4), the number of bytes in the AS/400 representation of the data type.

toBytes

public int toBytes(long longValue,
                   byte[] as400Value)
Converts the specified long into AS/400 format in the specified byte array.
Parameters:
longValue - The value to be converted to AS/400 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 AS/400 format. There must be enough space to hold the AS/400 value.
Returns:
Four (4), the number of bytes in the AS/400 representation of the data type.

toBytes

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

toBytes

public int toBytes(long longValue,
                   byte[] as400Value,
                   int offset)
Converts the specified long into AS/400 format in the specified byte array.
Parameters:
longValue - The value to be converted to AS/400 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 AS/400 format. There must be enough space to hold the AS/400 value.
offset - The offset into the byte array for the start of the AS/400 value. It must be greater than or equal to zero.
Returns:
Four (4), the number of bytes in the AS/400 representation of the data type.

toLong

public long toLong(byte[] as400Value)
Converts the specified AS/400 data type to a long.
Parameters:
as400Value - The array containing the data type in AS/400 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 AS/400 data type to a long.
Parameters:
as400Value - The array containing the data type in AS/400 format. The entire data type must be represented.
offset - The offset into the byte array for the start of the AS/400 value. It must be greater than or equal to zero.
Returns:
The long corresponding to the data type.

toObject

public java.lang.Object toObject(byte[] as400Value)
Converts the specified AS/400 data type to a Java object.
Specified by:
toObject in interface AS400DataType
Parameters:
as400Value - The array containing the data type in AS/400 format. The entire data type must be represented.
Returns:
The Long object corresponding to the data type.

toObject

public java.lang.Object toObject(byte[] as400Value,
                                 int offset)
Converts the specified AS/400 data type to a Java object.
Specified by:
toObject in interface AS400DataType
Parameters:
as400Value - The array containing the data type in AS/400 format. The entire data type must be represented.
offset - The offset into the byte array for the start of the AS/400 value. It must be greater than or equal to zero.
Returns:
The Long object corresponding to the data type.