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
024    private final transient Object value;
025    private final transient Class<?> type;
026
027    public TypeConversionException(Object value, Class<?> type, Throwable cause) {
028        super(createMessage(value, type, cause), cause);
029        this.value = value;
030        this.type = type;
031    }
032
033    /**
034     * Returns the value which could not be converted
035     */
036    public Object getValue() {
037        return value;
038    }
039
040    /**
041     * Returns the required <tt>to</tt> type
042     */
043    public Class<?> getToType() {
044        return type;
045    }
046
047    /**
048     * Returns the required <tt>from</tt> type.
049     * Returns <tt>null</tt> if the provided value was null.
050     */
051    public Class<?> getFromType() {
052        if (value != null) {
053            return value.getClass();
054        } else {
055            return null;
056        }
057    }
058
059    /**
060     * Returns an error message for type conversion failed.
061     */
062    public static String createMessage(Object value, Class<?> type, Throwable cause) {
063        return "Error during type conversion from type: " + (value != null ? value.getClass().getCanonicalName() : null)
064                + " to the required type: " + type.getCanonicalName() + " with value " + value + " due to " + cause.getClass().getName() + ": " + cause.getMessage();
065    }
066
067}
068
069