001/**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel;
018
019/**
020 * Exception when failing during type conversion.
021 */
022public class TypeConversionException extends RuntimeCamelException {
023    private static final long serialVersionUID = -6118520819865759886L;
024
025    private final transient Object value;
026    private final transient Class<?> type;
027
028    public TypeConversionException(Object value, Class<?> type, Throwable cause) {
029        super(createMessage(value, type, cause), cause);
030        this.value = value;
031        this.type = type;
032    }
033
034    /**
035     * Returns the value which could not be converted
036     */
037    public Object getValue() {
038        return value;
039    }
040
041    /**
042     * Returns the required <tt>to</tt> type
043     */
044    public Class<?> getToType() {
045        return type;
046    }
047
048    /**
049     * Returns the required <tt>from</tt> type.
050     * Returns <tt>null</tt> if the provided value was null.
051     */
052    public Class<?> getFromType() {
053        if (value != null) {
054            return value.getClass();
055        } else {
056            return null;
057        }
058    }
059
060    /**
061     * Returns an error message for type conversion failed.
062     */
063    public static String createMessage(Object value, Class<?> type, Throwable cause) {
064        return "Error during type conversion from type: " + (value != null ? value.getClass().getCanonicalName() : null)
065                + " to the required type: " + type.getCanonicalName() + " with value " + value + " due to " + cause.getClass().getName() + ": " + cause.getMessage();
066    }
067
068}
069
070