/*

  * 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 a read-only property was requested to be updated.

  */

 public class ReadOnlyPropertyException extends PropertyDescriptorException

 {

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

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

   /**

    * The class version identifier.

    * <p>

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

    */

   private static final long serialVersionUID = 1L;

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

   /**

    * The current value of the property that has not been changed.

    *

    * @serial

    */

   private final Serializable currentValue;

   /**

    * The value the property was requested to change to but has been rejected.

    *

    * @serial

    */

   private final Serializable rejectedValue;

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

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

   /**

    * Convenience constructor with no message and no root cause.

    *

    * @param propertyDescriptor the descriptor of the property raising the

    *          exception.

    * @param currentValue the current value of the property that has not been

    *          changed.

    * @param rejectedValue the value the property was requested to change to but

    *          has been rejected.

    */

   public ReadOnlyPropertyException(final PropertyDescriptor propertyDescriptor,

       final Object currentValue, final Object rejectedValue)

   {

     this(null, null, propertyDescriptor, currentValue, rejectedValue);

   }

   /**

    * Convenience constructor with no message.

    *

    * @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 currentValue the current value of the property that has not been

    *          changed.

    * @param rejectedValue the value the property was requested to change to but

    *          has been rejected.

    */

   public ReadOnlyPropertyException(final Throwable cause,

       final PropertyDescriptor propertyDescriptor, final Object currentValue,

       final Object rejectedValue)

   {

     this(null, cause, propertyDescriptor, currentValue, rejectedValue);

   }

   /**

    * Default constructor.

    *

    * @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 currentValue the current value of the property that has not been

    *          changed.

    * @param rejectedValue the value the property was requested to change to but

    *          has been rejected.

    */

   public ReadOnlyPropertyException(final String message, final Throwable cause,

       final PropertyDescriptor propertyDescriptor, final Object currentValue,

       final Object rejectedValue)

   {

     super(message == null ? createMessage(propertyDescriptor, currentValue,

         rejectedValue) : message, cause, propertyDescriptor);

     this.currentValue = makeSerializable(currentValue);

     this.rejectedValue = makeSerializable(rejectedValue);

   }

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

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

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

   private static String createMessage(

       final PropertyDescriptor propertyDescriptor, final Object currentValue,

       final Object rejectedValue)

   {

     return String.format(

         "Value '%s' of read-only property '%s' cannot be changed to '%s'.",

         currentValue, propertyDescriptor.getKey(), rejectedValue);

   }

   private static Serializable makeSerializable(final Object value)

   {

     return value instanceof Serializable ? (Serializable) value : String

         .valueOf(value);

   }

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

   /**

    * Returns the current value of the property that has not been changed.

    *

    * @return the current value of the property that has not been changed.

    */

   public final Serializable getCurrentValue()

   {

     return currentValue;

   }

   /**

    * Returns the value the property was requested to change to but has been

    * rejected.

    *

    * @return the value the property was requested to change to but has been

    *         rejected.

    */

   public final Serializable getRejectedValue()

   {

     return rejectedValue;

   }

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

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

 }