libjava/java/sql/DataTruncation.java

   1 /* DataTruncation.java -- Warning when data has been truncated.
   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 /**
  42   * This exception is thrown when a piece of data is unexpectedly
  43   * truncated in JDBC.
  44   *
  45   * @author Aaron M. Renn (arenn@urbanophile.com)
  46   */
  47 public class DataTruncation extends SQLWarning
  48 {
  49
  50 /*************************************************************************/
  51
  52 /*
  53  * Instance Variables
  54  */
  55
  56 /**
  57   * The original size of the data.
  58   * @serialized
  59   */
  60 private int dataSize;
  61
  62 /**
  63   * The index of the parameter or column whose value was truncated.
  64   * @serialized
  65   */
  66 private int index;
  67
  68 /**
  69   * Indicates whether or not a parameter value was truncated.
  70   * @serialized
  71   */
  72 private boolean parameter;
  73
  74 /**
  75   * Indicates whether or not a data column value was truncated.
  76   * @serialized
  77   */
  78 private boolean read;
  79
  80 /**
  81   * This is the size of the data after truncation.
  82   * @serialized
  83   */
  84 private int transferSize;
  85
  86 /*************************************************************************/
  87
  88 /**
  89   * Static Variables
  90   */
  91
  92 /**
  93   * This is the serialization UID for this class
  94   */
  95 private static final long serialVersionUID = 6464298989504059473L;
  96
  97 /*************************************************************************/
  98
  99 /*
 100  * Constructors
 101  */
 102
 103 /**
 104   * This method initializes a new instance of <code>DataTruncation</code>
 105   * with the specified values.  The descriptive error message for this
 106   * exception will be "Data truncation", the SQL state will be "01004"
 107   * and the vendor specific error code will be set to 0.
 108   *
 109   * @param index The index of the parameter or column that was truncated.
 110   * @param parameter <code>true</code> if a parameter was truncated,
 111   * <code>false</code> otherwise.
 112   * @param read <code>true</code> if a data column was truncated,
 113   * <code>false</code> otherwise.
 114   * @param dataSize The original size of the data.
 115   * @param transferSize The size of the data after truncation.
 116   */
 117 public
 118 DataTruncation(int index, boolean parameter, boolean read, int dataSize,
 119                int transferSize)
 120 {
 121   super("Data truncation", "01004");
 122
 123   this.index = index;
 124   this.parameter = parameter;
 125   this.read = read;
 126   this.dataSize = dataSize;
 127   this.transferSize = transferSize;
 128 }
 129
 130 /*************************************************************************/
 131
 132 /*
 133  * Instance Methods
 134  */
 135
 136 /**
 137   * This method returns the index of the column or parameter that was
 138   * truncated.
 139   *
 140   * @return The index of the column or parameter that was truncated.
 141   */
 142 public int
 143 getIndex()
 144 {
 145   return(index);
 146 }
 147
 148 /*************************************************************************/
 149
 150 /**
 151   * This method determines whether or not it was a parameter that was
 152   * truncated.
 153   *
 154   * @return <code>true</code> if a parameter was truncated, <code>false</code>
 155   * otherwise.
 156   */
 157 public boolean
 158 getParameter()
 159 {
 160   return(parameter);
 161 }
 162
 163 /*************************************************************************/
 164
 165 /**
 166   * This method determines whether or not it was a column that was
 167   * truncated.
 168   *
 169   * @return <code>true</code> if a column was truncated, <code>false</code>
 170   * otherwise.
 171   */
 172 public boolean
 173 getRead()
 174 {
 175   return(read);
 176 }
 177
 178 /*************************************************************************/
 179
 180 /**
 181   * This method returns the original size of the parameter or column that
 182   * was truncated.
 183   *
 184   * @return The original size of the parameter or column that was truncated.
 185   */
 186 public int
 187 getDataSize()
 188 {
 189   return(dataSize);
 190 }
 191
 192 /*************************************************************************/
 193
 194 /**
 195   * This method returns the size of the parameter or column after it was
 196   * truncated.
 197   *
 198   * @return The size of the parameter or column after it was truncated.
 199   */
 200 public int
 201 getTransferSize()
 202 {
 203   return(transferSize);
 204 }
 205
 206 } // class DataTruncation
 207