/*

  * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH

  *

  * Licensed under the Apache License, Version 2.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  *

  *     http://www.apache.org/licenses/LICENSE-2.0

  *

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package de.smartics.properties.api.core.domain;

 import java.io.Serializable;

 /**

  * Signals that the value does not match the given constraints.

  */

 public class PropertyValueConversionException extends

     PropertyDescriptorException

 {

   // ********************************* Fields *********************************

   // --- constants ------------------------------------------------------------

   /**

    * The class version identifier.

    * <p>

    * The value of this constant is {@value}.

    */

   private static final long serialVersionUID = 1L;

   // --- members --------------------------------------------------------------

   /**

    * The value of the property that does not meet the constraints.

    *

    * @serial

    */

   private final Serializable value;

   // ****************************** Initializer *******************************

   // ****************************** Constructors ******************************

   /**

    * Convenience constructor with no cause.

    *

    * @param propertyDescriptor the key descriptor the property raising the

    *          exception.

    * @param value the value of the property that does not meet the constraints.

    *          If the value is not serializable, its string representation is

    *          stored.

    */

   public PropertyValueConversionException(

       final PropertyDescriptor propertyDescriptor, final Object value)

   {

     this(null, propertyDescriptor, value);

   }

   /**

    * Default constructor.

    *

    * @param cause the cause (which is saved for later retrieval by the

    *          {@link #getCause()} method). (A <tt>null</tt> value is permitted,

    *          and indicates that the cause is nonexistent or unknown.)

    * @param propertyDescriptor the descriptor of the property raising the

    *          exception.

    * @param value the value of the property that cannot be converted. If the

    *          value is not serializable, its string representation is stored.

    */

   public PropertyValueConversionException(final Throwable cause,

       final PropertyDescriptor propertyDescriptor, final Object value)

   {

     this(createMessage(cause, propertyDescriptor, value), cause,

         propertyDescriptor, value);

   }

   /**

    * Internal constructor to provide a custom message.

    *

    * @param message the detail message (which is saved for later retrieval by

    *          the {@link #getMessage()} method).

    * @param cause the cause (which is saved for later retrieval by the

    *          {@link #getCause()} method). (A <tt>null</tt> value is permitted,

    *          and indicates that the cause is nonexistent or unknown.)

    * @param propertyDescriptor the descriptor of the property raising the

    *          exception.

    * @param value the value of the property that cannot be converted. If the

    *          value is not serializable, its string representation is stored.

    */

   protected PropertyValueConversionException(final String message,

       final Throwable cause, final PropertyDescriptor propertyDescriptor,

       final Object value)

   {

     super(message, cause, propertyDescriptor);

     this.value =

         value instanceof Serializable ? (Serializable) value : String

             .valueOf(value);

   }

   // ****************************** Inner Classes *****************************

   // ********************************* Methods ********************************

   // --- init -----------------------------------------------------------------

   private static String createMessage(final Throwable cause,

       final PropertyDescriptor propertyDescriptor, final Object value)

   {

     final StringBuilder buffer = new StringBuilder();

     buffer.append("Conversion failed for value '"

                   + value

                   + '\''

                   + (value != null ? " (" + value.getClass().getSimpleName()

                                      + ')' : "") + " for property '"

                   + propertyDescriptor.getKey() + "'");

     if (cause != null)

     {

       buffer.append(": ").append(cause.getMessage());

     }

     else

     {

       buffer.append('.');

     }

     return buffer.toString();

   }

   // --- get&set --------------------------------------------------------------

   /**

    * Returns the value of the property that does not meet the constraints.

    *

    * @return the value of the property that does not meet the constraints.

    */

   public final Serializable getValue()

   {

     return value;

   }

   // --- business -------------------------------------------------------------

   // --- object basics --------------------------------------------------------

 }