org.eclipse.persistence.exceptions.ConversionException Maven / Gradle / Ivy
Show all versions of eclipselink Show documentation
/*
* Copyright (c) 1998, 2021 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2018 IBM Corporation. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// Oracle - initial API and implementation from Oracle TopLink
// 02/19/2015 - Rick Curtis
// - 458877 : Add national character support
package org.eclipse.persistence.exceptions;
import java.util.*;
import org.eclipse.persistence.exceptions.i18n.ExceptionMessageGenerator;
/**
* Purpose: Conversion exceptions such as method or class not defined will raise this exception.
*/
public class ConversionException extends EclipseLinkException {
protected Class classToConvertTo;
protected transient Object sourceObject;
public final static int COULD_NOT_BE_CONVERTED = 3001;
public final static int COULD_NOT_BE_CONVERTED_EXTENDED = 3002;
public final static int INCORRECT_DATE_FORMAT = 3003;
public final static int INCORRECT_TIME_FORMAT = 3004;
public final static int INCORRECT_TIMESTAMP_FORMAT = 3005;
public final static int COULD_NOT_CONVERT_TO_BYTE_ARRAY = 3006;
public final static int COULD_NOT_BE_CONVERTED_TO_CLASS = 3007;
public final static int INCORRECT_DATE_TIME_FORMAT = 3008;
public final static int UNABLE_TO_SET_PROPERTIES = 3009;
/**
* INTERNAL:
* TopLink exceptions should only be thrown by TopLink.
* This constructor is only for error message scripting.
*/
protected ConversionException() {
super();
}
/**
* INTERNAL:
* TopLink exceptions should only be thrown by TopLink.
*/
protected ConversionException(String message, Object sourceObject, Class classToConvertTo, Exception exception) {
super(message, exception);
setSourceObject(sourceObject);
setClassToConvertTo(classToConvertTo);
}
// Couldn't find a way of simply changing the message on an existing exception.
// therefore, create a new exception with appropriate message and port existing
// info (stack trace and internal exception over)
public static ConversionException couldNotBeConverted(Object mapping, Object descriptor, ConversionException exception) {
Object sourceObject = exception.getSourceObject();
Class javaClass = exception.getClassToConvertTo();
Exception original = (Exception)exception.getInternalException();
Object[] args = { sourceObject, sourceObject.getClass(), mapping, descriptor, javaClass };
String message = ExceptionMessageGenerator.buildMessage(ConversionException.class, COULD_NOT_BE_CONVERTED_EXTENDED, args);
ConversionException conversionException = new ConversionException(message, sourceObject, javaClass, original);
conversionException.setStackTrace(exception.getStackTrace());
conversionException.setErrorCode(COULD_NOT_BE_CONVERTED_EXTENDED);
return conversionException;
}
public static ConversionException couldNotBeConverted(Object object, Class javaClass) {
Class objectClass = null;
if (object!=null) {
objectClass = object.getClass();
}
Object[] args = { object, objectClass, javaClass };
String message = ExceptionMessageGenerator.buildMessage(ConversionException.class, COULD_NOT_BE_CONVERTED, args);
ConversionException conversionException = new ConversionException(message, object, javaClass, null);
conversionException.setErrorCode(COULD_NOT_BE_CONVERTED);
return conversionException;
}
public static ConversionException couldNotBeConverted(Object object, Class javaClass, Exception exception) {
Class objectClass = null;
if (object!=null) {
objectClass = object.getClass();
}
Object[] args = { object, objectClass, javaClass };
String message = ExceptionMessageGenerator.buildMessage(ConversionException.class, COULD_NOT_BE_CONVERTED, args);
ConversionException conversionException = new ConversionException(message, object, javaClass, exception);
conversionException.setErrorCode(COULD_NOT_BE_CONVERTED);
return conversionException;
}
public static ConversionException couldNotBeConvertedToClass(Object object, Class javaClass, Exception exception) {
Object[] args = { object, object.getClass(), javaClass };
String message = ExceptionMessageGenerator.buildMessage(ConversionException.class, COULD_NOT_BE_CONVERTED_TO_CLASS, args);
ConversionException conversionException = new ConversionException(message, object, javaClass, exception);
conversionException.setErrorCode(COULD_NOT_BE_CONVERTED_TO_CLASS);
return conversionException;
}
public static ConversionException couldNotTranslatePropertiesIntoObject(Object object, String propertyName, String propertyValue, Exception cause) {
// Unable to set {0} properties [{1}] into [{2}]
Object[] args = { propertyName, propertyValue, object};
String message = ExceptionMessageGenerator.buildMessage(ConversionException.class, UNABLE_TO_SET_PROPERTIES, args);
ConversionException conversionException = new ConversionException(message, object, object.getClass(), cause);
conversionException.setErrorCode(UNABLE_TO_SET_PROPERTIES);
return conversionException;
}
public static ConversionException couldNotConvertToByteArray(Object object) {
Object[] args = { object };
String message = ExceptionMessageGenerator.buildMessage(ConversionException.class, COULD_NOT_CONVERT_TO_BYTE_ARRAY, args);
ConversionException conversionException = new ConversionException(message, object, byte[].class, null);
conversionException.setErrorCode(COULD_NOT_CONVERT_TO_BYTE_ARRAY);
return conversionException;
}
public static ConversionException incorrectDateFormat(String dateString) {
Object[] args = { dateString };
String message = ExceptionMessageGenerator.buildMessage(ConversionException.class, INCORRECT_DATE_FORMAT, args);
ConversionException conversionException = new ConversionException(message, dateString, java.sql.Date.class, null);
conversionException.setErrorCode(INCORRECT_DATE_FORMAT);
return conversionException;
}
public static ConversionException incorrectTimeFormat(String timeString) {
Object[] args = { timeString };
String message = ExceptionMessageGenerator.buildMessage(ConversionException.class, INCORRECT_TIME_FORMAT, args);
ConversionException conversionException = new ConversionException(message, timeString, java.sql.Time.class, null);
conversionException.setErrorCode(INCORRECT_TIME_FORMAT);
return conversionException;
}
public static ConversionException incorrectTimestampFormat(String timestampString) {
Object[] args = { timestampString };
String message = ExceptionMessageGenerator.buildMessage(ConversionException.class, INCORRECT_TIMESTAMP_FORMAT, args);
ConversionException conversionException = new ConversionException(message, timestampString, java.sql.Timestamp.class, null);
conversionException.setErrorCode(INCORRECT_TIMESTAMP_FORMAT);
return conversionException;
}
public static ConversionException incorrectDateTimeFormat(String dateTimeString, Class classBeingConvertedTo) {
Object[] args = { dateTimeString };
String message = ExceptionMessageGenerator.buildMessage(ConversionException.class, INCORRECT_DATE_TIME_FORMAT, args);
ConversionException conversionException = new ConversionException(message, dateTimeString, classBeingConvertedTo, null);
conversionException.setErrorCode(INCORRECT_DATE_TIME_FORMAT);
return conversionException;
}
public static ConversionException incorrectDateTimeFormat(String dateTimeString) {
return incorrectDateTimeFormat(dateTimeString, Calendar.class);
}
/**
* PUBLIC:
* Return the class to convert to.
*/
public Class getClassToConvertTo() {
return classToConvertTo;
}
/**
* PUBLIC:
* Return the object for which the problem was detected.
*/
public Object getSourceObject() {
return sourceObject;
}
/**
* INTERNAL:
* Set the class to convert to.
*/
public void setClassToConvertTo(Class classToConvertTo) {
this.classToConvertTo = classToConvertTo;
}
/**
* INTERNAL:
* Set the object for which the problem was detected.
*/
public void setSourceObject(Object sourceObject) {
this.sourceObject = sourceObject;
}
}