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