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