Package oracle.sql

Class TIMESTAMPTZ

  • All Implemented Interfaces:
    Serializable, oracle.jdbc.internal.OracleTimestampWithTimeZone

    public class TIMESTAMPTZ
    extends Datum
    implements oracle.jdbc.internal.OracleTimestampWithTimeZone
    TIMESTAMPTZ Class


    The TIMESTAMPTZ class provides conversions between the Oracle Date (ldx_t) data type and Java classes java.sql.Date, java.sql.Time, java.sql.Timestamp

    The internal data for this object is stored as a thirteen byte array in the super class' storage area. The bytes are arranged as follows:

          Byte       Represents
           0         Century (119 for 1990)
           1         Decade  (190 for 1990)
           2         Month
           3         Day      
           4         Hour
           5         Minute
           6         Seconds
           7         Nanoseconds (Most Significant bit)
           8         Nanoseconds
           9         Nanoseconds
           10        Nanoseconds (Least Significant Bit)
           11,12     Region id or Timezone Hour/Minute         
      
    The timezone information is stored as an offset in the RegionID format or in the HOUR/MINUTE format

    Static methods are used for conversions.

    See Also:
    Serialized Form
    • Constructor Detail

      • TIMESTAMPTZ

        public TIMESTAMPTZ()
        Constructs a TIMESTAMPTZ object initialized to 1/1/1970.
      • TIMESTAMPTZ

        public TIMESTAMPTZ​(byte[] timestamptz)
        Create an Oracle TIMESTAMPTZ object represented by the given Oracle Timestamptz
        Parameters:
        timestamptz - Oracle TIMESTAMPTZ
      • TIMESTAMPTZ

        public TIMESTAMPTZ​(Connection conn,
                           Date date)
                    throws SQLException
        Create an Oracle TIMESTAMPTZ object represented by the Java Date
        Parameters:
        conn - JDBC connection date Java Date object
        Throws:
        SQLException
      • TIMESTAMPTZ

        public TIMESTAMPTZ​(Connection conn,
                           Date date,
                           Calendar cal)
                    throws SQLException
        Create an Oracle TIMESTAMPTZ object represented by the Java Date and the Java Calendar object
        Parameters:
        conn - JDBC connection date Java Date object cal java Calendar object
        Throws:
        SQLException
      • TIMESTAMPTZ

        public TIMESTAMPTZ​(Connection conn,
                           Time time)
                    throws SQLException
        Create an Oracle TIMESTAMPTZ object represented by the given Java Time
        Parameters:
        conn - JDBC connection time Java Time object
        Throws:
        SQLException
      • TIMESTAMPTZ

        public TIMESTAMPTZ​(Connection conn,
                           Time time,
                           Calendar cal)
                    throws SQLException
        Create an Oracle TIMESTAMPTZ object represented by the given Java Time and the Java Calendar object
        Parameters:
        conn - JDBC connection time Java Time object cal java Calendar object
        Throws:
        SQLException
      • TIMESTAMPTZ

        public TIMESTAMPTZ​(Connection conn,
                           Timestamp timestamp)
                    throws SQLException
        Create an Oracle TIMESTAMPTZ object represented by the Java Timestamp
        Parameters:
        conn - JDBC connection timestamp Java Timestamp object
        Throws:
        SQLException
      • TIMESTAMPTZ

        public TIMESTAMPTZ​(Connection conn,
                           Timestamp timestamp,
                           Calendar cal)
                    throws SQLException
        Create an Oracle TIMESTAMPTZ object represented by the Java Timestamp and the Java Calendar object
        Parameters:
        conn - JDBC connection timestamp Java Timestamp object cal Java Calendar object
        Throws:
        SQLException
      • TIMESTAMPTZ

        public TIMESTAMPTZ​(Connection conn,
                           Timestamp timestamp,
                           java.time.ZoneId tzid)
                    throws SQLException
        Create an Oracle TIMESTAMPTZ object represented by the Java Timestamp with the specified ZoneId.
        Parameters:
        conn - JDBC connection timestamp Java Timestamp object tzidstamp Java ZoneId object
        Throws:
        SQLException
      • TIMESTAMPTZ

        public TIMESTAMPTZ​(Connection conn,
                           DATE date)
                    throws SQLException
        Create an Oracle TIMESTAMPTZ object represented by the Oracle DATE
        Parameters:
        conn - JDBC connection date Oracle DATE object
        Throws:
        SQLException
      • TIMESTAMPTZ

        public TIMESTAMPTZ​(Connection conn,
                           String str)
                    throws SQLException
        Create a TIMESTAMPTZ object given a Java String object.
        Parameters:
        conn - JDBC connection str Java String object
        Throws:
        SQLException
      • TIMESTAMPTZ

        public TIMESTAMPTZ​(Connection conn,
                           String str,
                           Calendar cal)
                    throws SQLException
        Create a TIMESTAMPTZ object given a Java String object.
        Parameters:
        conn - JDBC connection str Java String object cal Calendar object encapsulating the timezone
        Throws:
        SQLException
      • TIMESTAMPTZ

        public TIMESTAMPTZ​(java.time.OffsetDateTime odt)
                    throws SQLException
        Create a TIMESTAMPTZ object given a Java OffsetDateTime object.
        Parameters:
        odt - OffsetDateTime object
        Throws:
        SQLException
      • TIMESTAMPTZ

        public TIMESTAMPTZ​(java.time.ZonedDateTime zdt)
                    throws SQLException
        Create a TIMESTAMPTZ object given a Java ZonedDateTime object.
        Parameters:
        zdt - ZonedDateTime object
        Throws:
        SQLException
      • TIMESTAMPTZ

        public TIMESTAMPTZ​(Connection conn,
                           java.time.LocalDateTime ldt)
                    throws SQLException
        Create a TIMESTAMPTZ object given a Java LocalDateTime object.
        Parameters:
        ldt - LocalDateTime object
        Throws:
        SQLException
      • TIMESTAMPTZ

        public TIMESTAMPTZ​(java.time.OffsetTime ot)
                    throws SQLException
        Create a TIMESTAMPTZ object given a Java OffsetTime object.
        Parameters:
        ot - OffsetTime object
        Throws:
        SQLException
    • Method Detail

      • toDate

        public static Date toDate​(Connection conn,
                                  byte[] timestamptz)
                           throws SQLException
        Convert a byte array representing a TIMESTAMPTZ object to a Java Date Object
        Parameters:
        conn - JDBC connection timestamptz Oracle TIMESTAMPTZ object
        Returns:
        the Java Date object represented by Oracle TIMESTAMPTZ object
        Throws:
        SQLException
      • toDate2

        public static Date toDate2​(Connection conn,
                                   byte[] timestamptz)
                            throws SQLException
        Convert a byte array representing a TIMESTAMPTZ object to a Java Date Object in accordance with java.sql.Date specification.
        Parameters:
        conn - JDBC connection timestamptz Oracle TIMESTAMPTZ object in byte array
        Returns:
        the Java Date object represented by Oracle TIMESTAMPTZ object as per java.sql.Date standards. i.e w.r.t GMT timezone
        Throws:
        SQLException
      • toTime

        public static Time toTime​(Connection conn,
                                  byte[] timestamptz)
                           throws SQLException
        Convert a byte array representing a TIMESTAMPTZ object to a Java Time Object
        Parameters:
        conn - JDBC connection timestamptz Oracle TIMESTAMPTZ object
        Returns:
        the java.sql.Time object represented by Oracle TIMESTAMPTZ object. Only the hour, minute and seconds are contained in the java.sql.Time object that is returned and hence callers should not attempt to access the date component of the returned object.
        Throws:
        SQLException
      • toDATE

        public static DATE toDATE​(Connection conn,
                                  byte[] timestamptz)
                           throws SQLException
        Convert a byte array representing a TIMESTAMPTZ object to a Oracle DATE Object
        Parameters:
        conn - JDBC connection timestamptz Oracle TIMESTAMPTZ object
        Returns:
        the oracle DATE object represented by Oracle TIMESTAMPTZ object
        Throws:
        SQLException
      • toTIMESTAMP

        public static TIMESTAMP toTIMESTAMP​(Connection conn,
                                            byte[] timestamptz)
                                     throws SQLException
        Convert a byte array representing a TIMESTAMPTZ object to a Oracle TIMESTAMP Object
        Parameters:
        conn - JDBC connection timestamptz Oracle TIMESTAMPTZ object
        Returns:
        the Oracle TIMESTAMP object represented by Oracle TIMESTAMPTZ object
        Throws:
        SQLException
      • toTimestamp

        public static Timestamp toTimestamp​(Connection conn,
                                            byte[] timestamptz)
                                     throws SQLException
        Convert a byte array representing a TIMESTAMP WITH TIME ZONE object to a Java Timestamp Object
        Parameters:
        conn - JDBC connection timestamptz Oracle TIMESTAMPTZ object
        Returns:
        the Java Timestamp object represented by Oracle TIMESTAMPTZ object
        Throws:
        SQLException
      • toTimestamp2

        public static Timestamp toTimestamp2​(Connection conn,
                                             byte[] timestamptz)
                                      throws SQLException
        Convert a byte array representing a TIMESTAMPTZ object to a Java Timestamp Object
        Parameters:
        conn - JDBC connection timestamptz Oracle TIMESTAMPTZ object
        Returns:
        the Java Timestamp object represented by Oracle TIMESTAMPTZ object
        Throws:
        SQLException
      • toString

        public static String toString​(Connection conn,
                                      byte[] timestamptz)
                               throws SQLException
        Converts a TIMESTAMPTZ to a string
        Parameters:
        timestamptz - a byte array
        Returns:
        String representing the TIMESTAMPTZ
        Throws:
        SQLException
      • toOffsetDateTime

        public static java.time.OffsetDateTime toOffsetDateTime​(Connection conn,
                                                                byte[] timestamptz)
                                                         throws SQLException
        Converts a TIMESTAMPTZ to an OffsetDateTime
        Parameters:
        timestamptz - a byte array
        Returns:
        OffsetDateTime representing the TIMESTAMPTZ
        Throws:
        SQLException
      • toBytes

        public byte[] toBytes()
        Convert Oracle Timestamptz object into a byte array
        Specified by:
        toBytes in interface oracle.jdbc.internal.OracleTimestampWithTimeZone
        Returns:
        the byte array stored in the TIMESTAMPTZ object
      • toBytes

        public static byte[] toBytes​(Connection conn,
                                     Date date)
                              throws SQLException
        Convert Java Date to Oracle TIMESTAMPTZ.
        Parameters:
        conn - JDBC connection date Java Date object
        Returns:
        the byte array representing the java Date.
        Throws:
        SQLException
      • toBytes

        public static byte[] toBytes​(Connection conn,
                                     Date date,
                                     Calendar cal)
                              throws SQLException
        Convert Java Date to Oracle TIMESTAMPTZ.
        Parameters:
        conn - JDBC connection date Java Date object cal java Calendar object
        Returns:
        the byte array representing the java Date.
        Throws:
        SQLException
      • toBytes

        public static byte[] toBytes​(Connection conn,
                                     Time time)
                              throws SQLException
        Convert Java Time to Oracle TIMESTAMPTZ.
        Parameters:
        conn - JDBC connection time Java Time object
        Returns:
        the byte array representing the java Time.
        Throws:
        SQLException
      • toBytes

        public static byte[] toBytes​(Connection conn,
                                     Time time,
                                     Calendar cal)
                              throws SQLException
        Convert Java Time to Oracle TIMESTAMPTZ.
        Parameters:
        conn - JDBC connection time Java Time object cal java Calendar object
        Returns:
        the byte array representing the java Time.
        Throws:
        SQLException
      • toBytes

        public static byte[] toBytes​(Connection conn,
                                     Timestamp timestamp)
                              throws SQLException
        Convert Java Timestamp to Oracle TIMESTAMPTZ
        Parameters:
        conn - JDBC connection timestamp Java Timestamp object
        Returns:
        the byte array representing the TIMESTAMPTZ object.
        Throws:
        SQLException
      • toBytes

        public static byte[] toBytes​(Connection conn,
                                     Timestamp timestamp,
                                     Calendar cal)
                              throws SQLException
        Convert Java Timestamp to Oracle TIMESTAMPTZ
        Parameters:
        conn - JDBC connection timestamp Java Timestamp object cal Java Calendar object
        Returns:
        the byte array representing the TIMESTAMPTZ object.
        Throws:
        SQLException
      • toBytes

        public static byte[] toBytes​(Connection conn,
                                     Timestamp timestamp,
                                     java.time.ZoneId tzid)
                              throws SQLException
        Convert Java Timestamp to Oracle TIMESTAMPTZ
        Parameters:
        conn - JDBC connection timestamp Java Timestamp object tzid Java ZoneId object
        Returns:
        the byte array representing the TIMESTAMPTZ object.
        Throws:
        SQLException
      • toBytes

        public static byte[] toBytes​(Connection conn,
                                     DATE date)
                              throws SQLException
        Convert Oracle DATE to Oracle TIMESTAMPTZ
        Parameters:
        conn - JDBC connection date Oracle DATE object
        Returns:
        the byte array representing the Oracle TIMESTAMPTZ.
        Throws:
        SQLException
      • toBytes

        public static byte[] toBytes​(Connection conn,
                                     String str)
                              throws SQLException
        Convert Java String to Oracle TIMESTAMPTZ.
        Parameters:
        conn - JDBC Connection str java.lang.String object to be converted.
        Returns:
        the byte array representing the input string.
        Throws:
        SQLException
      • toBytes

        public static byte[] toBytes​(Connection conn,
                                     String str,
                                     Calendar cal)
                              throws SQLException
        Convert Java String to Oracle TIMESTAMPTZ.
        Parameters:
        conn - JDBC Connection str java.lang.String object to be converted. cal Calendar object encapsulating the timezone
        Returns:
        the byte array representing the input string.
        Throws:
        SQLException
      • stringValue

        public String stringValue​(Connection conn)
                           throws SQLException
        Calls toString to convert internal Oracle TIMESTAMPTZ to a Java String.
        Specified by:
        stringValue in interface oracle.jdbc.internal.OracleTimestampWithTimeZone
        Overrides:
        stringValue in class Datum
        Parameters:
        conn - oracle.JDBC.OracleConnection object
        Returns:
        a Java String value
        Throws:
        SQLException
      • toBytes

        public static byte[] toBytes​(java.time.OffsetDateTime odt)
                              throws SQLException
        Convert Java OffsetDateTime to Oracle TIMESTAMPTZ.
        Parameters:
        odt - OffsetDateTime object
        Returns:
        the byte array representing the java Date.
        Throws:
        SQLException
      • toBytes

        public static byte[] toBytes​(java.time.ZonedDateTime zdt)
                              throws SQLException
        Convert Java ZonedDateTime to Oracle TIMESTAMPTZ.
        Parameters:
        zdt - ZonedDateTime object
        Returns:
        the byte array representing the java Date.
        Throws:
        SQLException
      • toBytes

        public static byte[] toBytes​(Connection conn,
                                     java.time.LocalDateTime ldt)
                              throws SQLException
        Convert Java LocalDateTime to Oracle TIMESTAMPTZ.
        Parameters:
        zdt - LocalDateTime object
        Returns:
        the byte array representing the java Date.
        Throws:
        SQLException
      • toBytes

        public static byte[] toBytes​(java.time.OffsetTime ot)
                              throws SQLException
        Convert Java OffsetTime to Oracle TIMESTAMPTZ.
        Parameters:
        ot - OffsetTime object
        Returns:
        the byte array representing the java Date.
        Throws:
        SQLException
      • offsetDateTimeValue

        public java.time.OffsetDateTime offsetDateTimeValue​(Connection conn)
                                                     throws SQLException
        Calls toOffsetDateTime to convert internal Oracle TIMESTAMPTZ to a Java OffsetDateTime.
        Parameters:
        a - JDBC Connection object
        Returns:
        a Java OffsetDateTime
        Throws:
        SQLException
      • zonedDateTimeValue

        public java.time.ZonedDateTime zonedDateTimeValue()
                                                   throws SQLException
        Calls toZonedDateTime to convert internal Oracle TIMESTAMPTZ to a Java ZonedDateTime.
        Parameters:
        a - JDBC Connection object
        Returns:
        a Java ZonedDateTime
        Throws:
        SQLException
      • localDateTimeValue

        public java.time.LocalDateTime localDateTimeValue()
                                                   throws SQLException
        Calls toLocalDateTime to convert internal Oracle TIMESTAMPTZ to a Java LocalDateTime.
        Returns:
        a Java LocalDateTime
        Throws:
        SQLException
      • dateValue

        public Date dateValue​(Connection conn)
                       throws SQLException
        Calls toDate to convert internal Oracle TIMESTAMPTZ to a Java Date.
        Parameters:
        a - JDBC Connection object
        Returns:
        a Java Date
        Throws:
        SQLException
      • of

        public static TIMESTAMPTZ of​(java.time.ZonedDateTime zdt)
                              throws SQLException
        Creates TIMESTAMPTZ from the ZonedDateTime.
        Parameters:
        zdt - ZonedDateTime object
        Returns:
        TIMESTAMPTZ object
        Throws:
        SQLException
      • toZonedDateTime

        public java.time.ZonedDateTime toZonedDateTime()
                                                throws SQLException
        Converts TIMESTAMPTZ to ZonedDateTime.
        Returns:
        ZonedDateTime object.
        Throws:
        SQLException
      • toLocalDateTime

        public java.time.LocalDateTime toLocalDateTime()
                                                throws SQLException
        Converts TIMESTAMPTZ to LocalDateTime.
        Returns:
        LocalDateTime object.
        Throws:
        SQLException
      • toLocalDateTime

        public static java.time.LocalDateTime toLocalDateTime​(byte[] timestamptz)
                                                       throws SQLException
        Converts TIMESTAMPTZ to LocalDateTime.
        Parameters:
        timestamptz - TIMESTAMPTZ datum
        Returns:
        LocalDateTime object.
        Throws:
        SQLException
      • toZonedDateTime

        public static java.time.ZonedDateTime toZonedDateTime​(byte[] timestamptz)
                                                       throws SQLException
        Converts TIMESTAMPTZ to ZonedDateTime.
        Returns:
        ZonedDateTime object.
        Throws:
        SQLException
      • toOffsetTime

        public java.time.OffsetTime toOffsetTime()
                                          throws SQLException
        Converts a TIMESTAMPTZ to an OffsetTime
        Parameters:
        timestamptz - a byte array
        Returns:
        OffsetTime representing the TIMESTAMPTZ
        Throws:
        SQLException
      • of

        public static TIMESTAMPTZ of​(java.time.OffsetDateTime odt)
                              throws SQLException
        Creates TIMESTAMPTZ from the OffsetDateTime.
        Parameters:
        odt - OffsetDateTime object
        Returns:
        TIMESTAMPTZ object
        Throws:
        SQLException
      • of

        public static TIMESTAMPTZ of​(Connection conn,
                                     java.time.LocalDateTime ldt)
                              throws SQLException
        Creates TIMESTAMPTZ from the LocalDateTime.
        Parameters:
        conn - Connection object
        ldt - LocalDateTime object
        Returns:
        TIMESTAMPTZ object
        Throws:
        SQLException
      • toOffsetDateTime

        public java.time.OffsetDateTime toOffsetDateTime()
                                                  throws SQLException
        Converts TIMESTAMPTZ to OffsetDateTime.
        Returns:
        OffsetDateTime object.
        Throws:
        SQLException
      • toJdbc

        public Object toJdbc()
                      throws SQLException
        Returns the JDBC representation of the timestamptz object
        Specified by:
        toJdbc in class Datum
        Returns:
        an object containing the JDBC value
        Throws:
        SQLException - if conversion to JDBC representation results in an error
      • makeJdbcArray

        public Object makeJdbcArray​(int arraySize)
        Returns a JDBC array representation of the datum
        Specified by:
        makeJdbcArray in class Datum
        Parameters:
        arraySize - size of the array
        Returns:
        an object containing the JDBC array value
      • isConvertibleTo

        public boolean isConvertibleTo​(Class<?> cls)
        Determines if the object can be converted to a particular class
        Specified by:
        isConvertibleTo in class Datum
        Parameters:
        cls - Class to convert to
        Returns:
        true, if conversion to cls is permitted false, if conversion to cls is not permitted