DataTruncation

AI-generated Key Takeaways

• DataTruncation is a subclass of SQLWarning signaling unexpected data truncation, distinct from exceeding MaxFieldSize.

• It occurs during data reads or writes, with SQLstates 01004 and 22001 respectively.

• Provides methods to access details like the truncated value's index, data size before and after truncation, and whether it was a parameter or column value.

• Two constructors allow instantiation with or without specifying an underlying cause for the truncation.

public class DataTruncation extends SQLWarning

An exception thrown as a DataTruncation exception (on writes) or reported as a DataTruncation warning (on reads) when a data values is unexpectedly truncated for reasons other than its having execeeded MaxFieldSize.

The SQLstate for a DataTruncation during read is 01004.

The SQLstate for a DataTruncation during write is 22001.

Public Constructor Summary

	DataTruncation(int index, boolean parameter, boolean read, int dataSize, int transferSize) Creates a DataTruncation object with the SQLState initialized to 01004 when read is set to true and 22001 when read is set to false, the reason set to "Data truncation", the vendor code set to 0, and the other fields set to the given values.
	DataTruncation(int index, boolean parameter, boolean read, int dataSize, int transferSize, Throwable cause) Creates a DataTruncation object with the SQLState initialized to 01004 when read is set to true and 22001 when read is set to false, the reason set to "Data truncation", the vendor code set to 0, and the other fields set to the given values.

Public Method Summary

int	getDataSize() Gets the number of bytes of data that should have been transferred.
int	getIndex() Retrieves the index of the column or parameter that was truncated.
boolean	getParameter() Indicates whether the value truncated was a parameter value or a column value.
boolean	getRead() Indicates whether or not the value was truncated on a read.
int	getTransferSize() Gets the number of bytes of data actually transferred.

Inherited Method Summary

From class java.sql.SQLWarning

SQLWarning	getNextWarning() Retrieves the warning chained to this SQLWarning object by setNextWarning.
void	setNextWarning(SQLWarning w) Adds a SQLWarning object to the end of the chain.

From class java.sql.SQLException

int	getErrorCode() Retrieves the vendor-specific exception code for this SQLException object.
SQLException	getNextException() Retrieves the exception chained to this SQLException object by setNextException(SQLException ex).
String	getSQLState() Retrieves the SQLState for this SQLException object.
Iterator<Throwable>	iterator() Returns an iterator over the chained SQLExceptions.
void	setNextException(SQLException ex) Adds an SQLException object to the end of the chain.

From class java.lang.Throwable

synchronized final void	addSuppressed(Throwable exception) Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.
synchronized Throwable	fillInStackTrace() Fills in the execution stack trace.
synchronized Throwable	getCause() Returns the cause of this throwable or null if the cause is nonexistent or unknown.
String	getLocalizedMessage() Creates a localized description of this throwable.
String	getMessage() Returns the detail message string of this throwable.
StackTraceElement[]	getStackTrace() Provides programmatic access to the stack trace information printed by printStackTrace().
synchronized final Throwable[]	getSuppressed() Returns an array containing all of the exceptions that were suppressed, typically by the try-with-resources statement, in order to deliver this exception.
synchronized Throwable	initCause(Throwable cause) Initializes the cause of this throwable to the specified value.
void	printStackTrace() Prints this throwable and its backtrace to the standard error stream.
void	printStackTrace(PrintWriter s) Prints this throwable and its backtrace to the specified print writer.
void	printStackTrace(PrintStream s) Prints this throwable and its backtrace to the specified print stream.
void	setStackTrace(StackTraceElement[] stackTrace) Sets the stack trace elements that will be returned by getStackTrace() and printed by printStackTrace() and related methods.
String	toString() Returns a short description of this throwable.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.lang.Iterable

void	forEach(Consumer<? super T> action) Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception.
abstract Iterator<Throwable>	iterator() Returns an iterator over elements of type T.
Spliterator<Throwable>	spliterator() Creates a Spliterator over the elements described by this Iterable.

Public Constructors

public DataTruncation (int index, boolean parameter, boolean read, int dataSize, int transferSize)

Creates a DataTruncation object with the SQLState initialized to 01004 when read is set to true and 22001 when read is set to false, the reason set to "Data truncation", the vendor code set to 0, and the other fields set to the given values. The cause is not initialized, and may subsequently be initialized by a call to the Throwable.initCause(java.lang.Throwable) method.

Parameters

index	The index of the parameter or column value
parameter	true if a parameter value was truncated
read	true if a read was truncated
dataSize	the original size of the data
transferSize	the size after truncation

public DataTruncation (int index, boolean parameter, boolean read, int dataSize, int transferSize, Throwable cause)

Creates a DataTruncation object with the SQLState initialized to 01004 when read is set to true and 22001 when read is set to false, the reason set to "Data truncation", the vendor code set to 0, and the other fields set to the given values.

Parameters

index	The index of the parameter or column value
parameter	true if a parameter value was truncated
read	true if a read was truncated
dataSize	the original size of the data
transferSize	the size after truncation
cause	the underlying reason for this DataTruncation (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.

Public Methods

public int getDataSize ()

Gets the number of bytes of data that should have been transferred. This number may be approximate if data conversions were being performed. The value may be -1 if the size is unknown.

Returns

• the number of bytes of data that should have been transferred

public int getIndex ()

Retrieves the index of the column or parameter that was truncated.

This may be -1 if the column or parameter index is unknown, in which case the parameter and read fields should be ignored.

Returns

• the index of the truncated paramter or column value

public boolean getParameter ()

Indicates whether the value truncated was a parameter value or a column value.

Returns

• true if the value truncated was a parameter; false if it was a column value

public boolean getRead ()

Indicates whether or not the value was truncated on a read.

Returns

• true if the value was truncated when read from the database; false if the data was truncated on a write

public int getTransferSize ()

Gets the number of bytes of data actually transferred. The value may be -1 if the size is unknown.

Returns

• the number of bytes of data actually transferred