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 * An exception thrown if a value could not be converted to the required type
021 *
022 * @version 
023 */
024public class NoTypeConversionAvailableException extends CamelException {
025    private static final long serialVersionUID = -8721487434390572636L;
026
027    private final transient Object value;
028    private final transient Class<?> type;
029
030    public NoTypeConversionAvailableException(Object value, Class<?> type) {
031        super(createMessage(value, type));
032        this.value = value;
033        this.type = type;
034    }
035
036    public NoTypeConversionAvailableException(Object value, Class<?> type, Throwable cause) {
037        super(createMessage(value, type, cause), cause);
038        this.value = value;
039        this.type = type;
040    }
041
042    /**
043     * Returns the value which could not be converted
044     */
045    public Object getValue() {
046        return value;
047    }
048
049    /**
050     * Returns the required <tt>to</tt> type
051     */
052    public Class<?> getToType() {
053        return type;
054    }
055
056    /**
057     * Returns the required <tt>from</tt> type.
058     * Returns <tt>null</tt> if the provided value was null.
059     */
060    public Class<?> getFromType() {
061        if (value != null) {
062            return value.getClass();
063        } else {
064            return null;
065        }
066    }
067
068    /**
069     * Returns an error message for no type converter available.
070     */
071    public static String createMessage(Object value, Class<?> type) {
072        return "No type converter available to convert from type: " + (value != null ? value.getClass().getCanonicalName() : null)
073              + " to the required type: " + type.getCanonicalName() + " with value " + value;
074    }
075    
076    /**
077     * Returns an error message for no type converter available with the cause.
078     */
079    public static String createMessage(Object value, Class<?> type, Throwable cause) {
080        return "Converting Exception when converting from type: "
081               + (value != null ? value.getClass().getCanonicalName() : null) + " to the required type: "
082               + type.getCanonicalName() + " with value " + value + ", which is caused by " + cause;
083    }
084}