001/**
002 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
003 *   This file is part of the LDP4j Project:
004 *     http://www.ldp4j.org/
005 *
006 *   Center for Open Middleware
007 *     http://www.centeropenmiddleware.com/
008 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
009 *   Copyright (C) 2014-2016 Center for Open Middleware.
010 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
011 *   Licensed under the Apache License, Version 2.0 (the "License");
012 *   you may not use this file except in compliance with the License.
013 *   You may obtain a copy of the License at
014 *
015 *             http://www.apache.org/licenses/LICENSE-2.0
016 *
017 *   Unless required by applicable law or agreed to in writing, software
018 *   distributed under the License is distributed on an "AS IS" BASIS,
019 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
020 *   See the License for the specific language governing permissions and
021 *   limitations under the License.
022 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
023 *   Artifact    : org.ldp4j.framework:ldp4j-application-api:0.2.2
024 *   Bundle      : ldp4j-application-api-0.2.2.jar
025 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
026 */
027package org.ldp4j.application.ext;
028
029import org.ldp4j.application.ApplicationApiRuntimeException;
030
031/**
032 * This exception is thrown when a parameter raw value cannot be transformed to
033 * an instance of a given type.
034 *
035 * @see Parameter#rawValueAs(Class)
036 * @see Parameter#rawValuesAs(Class)
037 */
038public class ObjectTransformationException extends ApplicationApiRuntimeException {
039
040  private static final long serialVersionUID = 1526607378071322725L;
041
042  private final Class<?> valueClass;
043
044  /**
045   * Create a new instance with a message, cause, and valueClass
046   *
047   * @param message
048   *            the description of the failure
049   * @param cause
050   *            the underlying cause of the exception
051   * @param valueClass
052   *            the type to which the raw value could not be transformed to
053   */
054  public ObjectTransformationException(String message, Throwable cause, Class<?> valueClass) {
055    super(message, cause);
056    this.valueClass = valueClass;
057  }
058
059  /**
060   * Returns the {@code Class} of the type to which a raw value could not be
061   * transfomed.
062   *
063   * @return the {@code Class} of the type to which a raw value could not be
064   * transfomed
065   */
066  public Class<?> getValueClass() {
067    return this.valueClass;
068  }
069
070}