Source for java.sql.DataTruncation

   1: /* DataTruncation.java -- Warning when data has been truncated.
   2:    Copyright (C) 1999, 2000, 2002 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., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 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: package java.sql;
  39: 
  40: /**
  41:   * This exception is thrown when a piece of data is unexpectedly 
  42:   * truncated in JDBC.
  43:   *
  44:   * @author Aaron M. Renn (arenn@urbanophile.com)
  45:   */
  46: public class DataTruncation extends SQLWarning 
  47: {
  48:   static final long serialVersionUID = 6464298989504059473L;
  49: 
  50:   /**
  51:    * The original size of the data.
  52:    */
  53:   private int dataSize;
  54: 
  55:   /**
  56:    * The index of the parameter or column whose value was truncated.
  57:    */
  58:   private int index;
  59: 
  60:   /**
  61:    * Indicates whether or not a parameter value was truncated.
  62:    */
  63:   private boolean parameter;
  64: 
  65:   /**
  66:    * Indicates whether or not a data column value was truncated.
  67:    */
  68:   private boolean read;
  69: 
  70:   /**
  71:    * This is the size of the data after truncation.
  72:    */
  73:   private int transferSize;
  74: 
  75:   /**
  76:    * This method initializes a new instance of <code>DataTruncation</code>
  77:    * with the specified values.  The descriptive error message for this 
  78:    * exception will be "Data truncation", the SQL state will be "01004"
  79:    * and the vendor specific error code will be set to 0.
  80:    *
  81:    * @param index The index of the parameter or column that was truncated.
  82:    * @param parameter <code>true</code> if a parameter was truncated,
  83:    *        <code>false</code> otherwise.
  84:    * @param read <code>true</code> if a data column was truncated,
  85:    *        <code>false</code> otherwise.
  86:    * @param dataSize The original size of the data.
  87:    * @param transferSize The size of the data after truncation.
  88:    */
  89:   public DataTruncation(int index, boolean parameter, boolean read, int
  90:     dataSize, int transferSize)
  91:   {
  92:     super("Data truncation", "01004");
  93: 
  94:     this.index = index;
  95:     this.parameter = parameter;
  96:     this.read = read;
  97:     this.dataSize = dataSize;
  98:     this.transferSize = transferSize;
  99:   }
 100: 
 101:   /**
 102:    * This method returns the index of the column or parameter that was
 103:    * truncated.
 104:    *
 105:    * @return The index of the column or parameter that was truncated.
 106:    */
 107:   public int getIndex()
 108:   {
 109:     return index;
 110:   }
 111: 
 112:   /**
 113:    * This method determines whether or not it was a parameter that was
 114:    * truncated.
 115:    *
 116:    * @return <code>true</code> if a parameter was truncated, <code>false</code>
 117:    * otherwise.
 118:    */
 119:   public boolean getParameter()
 120:   {
 121:     return parameter;
 122:   }
 123: 
 124:   /**
 125:    * This method determines whether or not it was a column that was
 126:    * truncated.
 127:    *
 128:    * @return <code>true</code> if a column was truncated, <code>false</code>
 129:    * otherwise.
 130:    */
 131:   public boolean getRead()
 132:   {
 133:     return read;
 134:   }
 135: 
 136:   /**
 137:    * This method returns the original size of the parameter or column that
 138:    * was truncated.
 139:    *
 140:    * @return The original size of the parameter or column that was truncated.
 141:    */
 142:   public int getDataSize()
 143:   {
 144:     return dataSize;
 145:   }
 146: 
 147:   /**
 148:    * This method returns the size of the parameter or column after it was
 149:    * truncated.
 150:    *
 151:    * @return The size of the parameter or column after it was truncated.
 152:    */
 153:   public int getTransferSize()
 154:   {
 155:     return transferSize;
 156:   }
 157: }