com.ibm.as400.access
Class AS400Bin1

java.lang.Object
  extended by com.ibm.as400.access.AS400Bin1
All Implemented Interfaces:
AS400DataType, Serializable, Cloneable

public class AS400Bin1
extends Object
implements AS400DataType

Provides a converter between a Byte object and a signed one-byte binary number. The range of values representable by this data type is -128 through 127 (Byte.MIN_VALUE through Byte.MAX_VALUE).

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:
AS400UnsignedBin1, 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_ZONED
 
Constructor Summary
AS400Bin1()
          Constructs an AS400Bin1 object.
 
Method Summary
 Object clone()
          Creates a new AS400Bin1 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_BIN1.
 Class getJavaType()
          Returns the Java class that corresponds with this data type.
 byte toByte(byte[] as400Value)
          Converts the specified IBM i data type to a byte.
 byte toByte(byte[] as400Value, int offset)
          Converts the specified IBM i data type to a byte.
 byte[] toBytes(byte byteValue)
          Converts the specified byte to IBM i format.
 int toBytes(byte byteValue, byte[] as400Value)
          Converts the specified byte into IBM i format in the specified byte array.
 int toBytes(byte byteValue, byte[] as400Value, int offset)
          Converts the specified byte 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.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AS400Bin1

public AS400Bin1()
Constructs an AS400Bin1 object.

Method Detail

clone

public Object clone()
Creates a new AS400Bin1 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 Byte object with a value of zero.

getInstanceType

public int getInstanceType()
Returns TYPE_BIN1.

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

getJavaType

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

Specified by:
getJavaType in interface AS400DataType
Returns:
Byte.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 Byte.
Returns:
The IBM i representation of the data type.

toBytes

public byte[] toBytes(byte byteValue)
Converts the specified byte to IBM i format.

Parameters:
byteValue - The value to be converted to IBM i format.
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 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(byte byteValue,
                   byte[] as400Value)
Converts the specified byte into IBM i format in the specified byte array.

Parameters:
byteValue - The value to be converted to IBM i format.
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 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.

toBytes

public int toBytes(byte byteValue,
                   byte[] as400Value,
                   int offset)
Converts the specified byte into IBM i format in the specified byte array.

Parameters:
byteValue - The value to be converted to IBM i format.
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 Byte 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 Byte object corresponding to the data type.

toByte

public byte toByte(byte[] as400Value)
Converts the specified IBM i data type to a byte.

Parameters:
as400Value - The array containing the data type in IBM i format. The entire data type must be represented.
Returns:
The byte corresponding to the data type.

toByte

public byte toByte(byte[] as400Value,
                   int offset)
Converts the specified IBM i data type to a byte.

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 byte corresponding to the data type.