libjava/java/sql/Timestamp.java

   1 /* Time.java -- Wrapper around java.util.Date
   2    Copyright (C) 1999, 2000 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.sql;
  40
  41 import java.text.SimpleDateFormat;
  42
  43 /**
  44   * This class is a wrapper around java.util.Date to allow the JDBC
  45   * driver to identify the value as a SQL Timestamp.  Note that this
  46   * class also adds an additional field for nano-seconds, and so
  47   * is not completely identical to <code>java.util.Date</code> as
  48   * the <code>java.sql.Date</code> and <code>java.sql.Time</code>
  49   * classes are.
  50   *
  51   * @author Aaron M. Renn (arenn@urbanophile.com)
  52   */
  53 public class Timestamp extends java.util.Date
  54 {
  55
  56 /*
  57  * Class Variables
  58  */
  59
  60 /**
  61   * Used for parsing and formatting this date.
  62   */
  63   // Millisecond will have to be close enough for now.
  64 private static SimpleDateFormat parse_sdf =
  65   new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSSS");
  66
  67 private static SimpleDateFormat format_sdf =
  68   new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  69
  70 /**
  71   * This is the serialization UID for this class.
  72   */
  73 private static final long serialVersionUID = 3581463369166924961L;
  74
  75 /*************************************************************************/
  76
  77 /*
  78  * Instance Variables
  79  */
  80
  81 /**
  82   * @serial The nanosecond value for this object
  83   */
  84 private int nanos;
  85
  86 /*************************************************************************/
  87
  88 /*
  89  * Class Methods
  90  */
  91
  92 /**
  93   * This method returns a new instance of this class by parsing a
  94   * date in JDBC format into a Java date.
  95   *
  96   * @param str The string to parse.
  97   *
  98   * @return The resulting <code>java.sql.Timestamp</code> value.
  99   */
 100 public static Timestamp
 101 valueOf(String str)
 102 {
 103   try
 104     {
 105       Date d = (Date)parse_sdf.parseObject(str);
 106       return(new Timestamp(d.getTime()));
 107     }
 108   catch(Exception e)
 109     {
 110       return(null);
 111     }
 112 }
 113
 114 /*************************************************************************/
 115
 116 /*
 117  * Constructors
 118  */
 119
 120 /**
 121   * This method initializes a new instance of this class with the
 122   * specified year, month, and day.
 123   *
 124   * @param year The year for this Timestamp (year - 1900)
 125   * @param month The month for this Timestamp (0-11)
 126   * @param day The day for this Timestamp (1-31)
 127   * @param hour The hour for this Timestamp (0-23)
 128   * @param minute The minute for this Timestamp (0-59)
 129   * @param second The second for this Timestamp (0-59)
 130   * @param nanos The nanosecond value for this Timestamp (0 to 999,999,9999)
 131   *
 132   * @deprecated
 133   */
 134 public
 135 Timestamp(int year, int month, int day, int hour, int minute, int second,
 136           int nanos)
 137 {
 138   super(year, month, day, hour, minute, second);
 139
 140   this.nanos = nanos;
 141 }
 142
 143 /*************************************************************************/
 144
 145 /**
 146   * This method initializes a new instance of this class with the
 147   * specified time value representing the number of seconds since
 148   * Jan 1, 1970 at 12:00 midnight GMT.
 149   *
 150   * @param time The time value to intialize this <code>Time</code> to.
 151   */
 152 public
 153 Timestamp(long date)
 154 {
 155   super(date);
 156 }
 157
 158 /*************************************************************************/
 159
 160 /*
 161  * Instance Methods
 162  */
 163
 164 /**
 165   * This method returns this date in JDBC format.
 166   *
 167   * @return This date as a string.
 168   */
 169 public String
 170 toString()
 171 {
 172   return(format_sdf.format(this) + "." + getNanos());
 173 }
 174
 175 /*************************************************************************/
 176
 177 /**
 178   * This method returns the nanosecond value for this object.
 179   *
 180   * @return The nanosecond value for this object.
 181   */
 182 public int
 183 getNanos()
 184 {
 185   return(nanos);
 186 }
 187
 188 /*************************************************************************/
 189
 190 /**
 191   * This method sets the nanosecond value for this object.
 192   *
 193   * @param nanos The nanosecond value for this object.
 194   */
 195 public void
 196 setNanos(int nanos)
 197 {
 198   this.nanos = nanos;
 199 }
 200
 201 /*************************************************************************/
 202
 203 /**
 204   * This methods tests whether this object is earlier than the specified
 205   * object.
 206   *
 207   * @param ts The other <code>Timestamp</code> to test against.
 208   *
 209   * @return <code>true</code> if this object is earlier than the other object,
 210   * <code>false</code> otherwise.
 211   */
 212 public boolean
 213 before(Timestamp ts)
 214 {
 215   if (ts.getTime() > getTime())
 216     return(true);
 217
 218   if (ts.getNanos() > getNanos())
 219     return(true);
 220
 221   return(false);
 222 }
 223
 224 /*************************************************************************/
 225
 226 /**
 227   * This methods tests whether this object is later than the specified
 228   * object.
 229   *
 230   * @param ts The other <code>Timestamp</code> to test against.
 231   *
 232   * @return <code>true</code> if this object is later than the other object,
 233   * <code>false</code> otherwise.
 234   */
 235 public boolean
 236 after(Timestamp ts)
 237 {
 238   if (ts.getTime() < getTime())
 239     return(true);
 240
 241   if (ts.getNanos() < getNanos())
 242     return(true);
 243
 244   return(false);
 245 }
 246
 247 /*************************************************************************/
 248
 249 /**
 250   * This method these the specified <code>Object</code> for equality
 251   * against this object.  This will be true if an only if the specified
 252   * object is an instance of <code>Timestamp</code> and has the same
 253   * time value fields.
 254   *
 255   * @param obj The object to test against for equality.
 256   *
 257   * @return <code>true</code> if the specified object is equal to this
 258   * object, <code>false</code> otherwise.
 259   */
 260 public boolean
 261 equals(Object obj)
 262 {
 263   if (obj == null)
 264     return(false);
 265
 266   if (!(obj instanceof Timestamp))
 267     return(false);
 268
 269   return(equals((Timestamp)obj));
 270 }
 271
 272 /*************************************************************************/
 273
 274 /**
 275   * This method tests the specified timestamp for equality against this
 276   * object.  This will be true if and only if the specified object is
 277   * not <code>null</code> and contains all the same time value fields
 278   * as this object.
 279   *
 280   * @param ts The <code>Timestamp</code> to test against for equality.
 281   *
 282   * @return <code>true</code> if the specified object is equal to this
 283   * object, <code>false</code> otherwise.
 284   */
 285 public boolean
 286 equals(Timestamp ts)
 287 {
 288   if (ts == null)
 289     return(false);
 290
 291   if (ts.getTime() != getTime())
 292     return(false);
 293
 294   if (ts.getNanos() != getNanos())
 295     return(false);
 296
 297   return(true);
 298 }
 299
 300 } // class Timestamp
 301