com.ibm.as400.access
Class AS400AbstractTime

java.lang.Object
  extended by com.ibm.as400.access.AS400AbstractTime
All Implemented Interfaces:
AS400DataType, Serializable, Cloneable
Direct Known Subclasses:
AS400Date, AS400Time, AS400Timestamp

public abstract class AS400AbstractTime
extends Object
implements AS400DataType

An abstract base class for converters between IBM i date/time values and corresponding Java objects.

See Also:
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
 
Method Summary
 Object clone()
          Creates a new AS400AbstractTime object that is identical to the current instance.
 int getByteLength()
          Returns the byte length of the data type.
abstract  Object getDefaultValue()
          Returns a Java object representing the default value of the data type.
abstract  int getInstanceType()
          Returns an integer constant representing the type of class that implements this interface.
abstract  Class getJavaType()
          Returns the Java class that corresponds with this data type.
 TimeZone getTimeZone()
           
 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.
abstract  Object toObject(byte[] as400Value, int offset)
          Converts the specified IBM i data type to a Java object.
abstract  String toString(Object javaValue)
          Converts the specified Java object into a String representation that is consistent with the format of this data type.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getTimeZone

public TimeZone getTimeZone()

clone

public Object clone()
Creates a new AS400AbstractTime 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 abstract Object getDefaultValue()
Returns a Java object representing the default value of the data type.

Specified by:
getDefaultValue in interface AS400DataType
Returns:
The default value of the data type.

getInstanceType

public abstract int getInstanceType()
Returns an integer constant representing the type of class that implements this interface. This is typically faster than using the instanceof operator, and may prove useful where code needs a primitive type for ease of calculation. Possible values for standard com.ibm.as400.access classes that implement this interface are provided as constants in this class. Note that any implementing class provided by a third party is not guaranteed to correctly return one of the pre-defined constants.

Specified by:
getInstanceType in interface AS400DataType
Returns:
The type of object implementing this interface.

getJavaType

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

Specified by:
getJavaType in interface AS400DataType
Returns:
The Java class that corresponds with this data type.

toBytes

public byte[] toBytes(Object javaValue)
Converts the specified Java object to IBM i format. This method performs the same conversion as tobytes(javaValue,as400Value,0), except that as400Value is created dynamically and returned by this method.

Specified by:
toBytes in interface AS400DataType
Parameters:
javaValue - The object corresponding to the data type.
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. This method performs the same conversion as tobytes(javaValue,as400Value,0).

Specified by:
toBytes in interface AS400DataType
Parameters:
javaValue - The object corresponding to the data type.
as400Value - The array to receive the data type in IBM i format. There must be enough space to hold the IBM i value.
Returns:
Eight (8), 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.
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:
Eight (8), 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. This method performs the same conversion as toObject(as400Value,0).

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

toObject

public abstract 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 Java object corresponding to the data type.

toString

public abstract String toString(Object javaValue)
Converts the specified Java object into a String representation that is consistent with the format of this data type.

Parameters:
javaValue - The object corresponding to the data type.
Returns:
A String representation of the specified value, formatted appropriately for this data type.