path: root/libjava/java/sql/DataTruncation.java

/* DataTruncation.java -- Warning when data has been truncated.
   Copyright (C) 1999, 2000, 2002 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
 
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

package java.sql;

/**
  * This exception is thrown when a piece of data is unexpectedly 
  * truncated in JDBC.
  *
  * @author Aaron M. Renn (arenn@urbanophile.com)
  */
public class DataTruncation extends SQLWarning 
{
  static final long serialVersionUID = 6464298989504059473L;

  /**
   * The original size of the data.
   */
  private int dataSize;

  /**
   * The index of the parameter or column whose value was truncated.
   */
  private int index;

  /**
   * Indicates whether or not a parameter value was truncated.
   */
  private boolean parameter;

  /**
   * Indicates whether or not a data column value was truncated.
   */
  private boolean read;

  /**
   * This is the size of the data after truncation.
   */
  private int transferSize;

  /**
   * This method initializes a new instance of <code>DataTruncation</code>
   * with the specified values.  The descriptive error message for this 
   * exception will be "Data truncation", the SQL state will be "01004"
   * and the vendor specific error code will be set to 0.
   *
   * @param index The index of the parameter or column that was truncated.
   * @param parameter <code>true</code> if a parameter was truncated,
   *        <code>false</code> otherwise.
   * @param read <code>true</code> if a data column was truncated,
   *        <code>false</code> otherwise.
   * @param dataSize The original size of the data.
   * @param transferSize The size of the data after truncation.
   */
  public DataTruncation(int index, boolean parameter, boolean read, int
    dataSize, int transferSize)
  {
    super("Data truncation", "01004");

    this.index = index;
    this.parameter = parameter;
    this.read = read;
    this.dataSize = dataSize;
    this.transferSize = transferSize;
  }

  /**
   * This method returns the index of the column or parameter that was
   * truncated.
   *
   * @return The index of the column or parameter that was truncated.
   */
  public int getIndex()
  {
    return index;
  }

  /**
   * This method determines whether or not it was a parameter that was
   * truncated.
   *
   * @return <code>true</code> if a parameter was truncated, <code>false</code>
   * otherwise.
   */
  public boolean getParameter()
  {
    return parameter;
  }

  /**
   * This method determines whether or not it was a column that was
   * truncated.
   *
   * @return <code>true</code> if a column was truncated, <code>false</code>
   * otherwise.
   */
  public boolean getRead()
  {
    return read;
  }

  /**
   * This method returns the original size of the parameter or column that
   * was truncated.
   *
   * @return The original size of the parameter or column that was truncated.
   */
  public int getDataSize()
  {
    return dataSize;
  }

  /**
   * This method returns the size of the parameter or column after it was
   * truncated.
   *
   * @return The size of the parameter or column after it was truncated.
   */
  public int getTransferSize()
  {
    return transferSize;
  }
}