/*
    * 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;
  import java.util.List;
  
  
  
  /**
   * Signals that the value does not match the given constraints.
   */
  public class PropertyValidationException extends PropertyDescriptorException
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     * <p>
     * The value of this constant is {@value}.
     */
    private static final long serialVersionUID = 1L;
  
    // --- members --------------------------------------------------------------
  
    /**
     * The property constraints that failed to be met.
     *
     * @serial
     */
    private final List<? extends PropertyConstraint<?>> constraints;
  
    /**
     * The value of the property that does not meet the constraints.
     *
     * @serial
     */
    private final Serializable value;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Convenience constructor with no message and no root cause.
     *
     * @param propertyDescriptor the descriptor of the property raising the
     *          exception.
     * @param constraints the property constraints that failed to be met.
     * @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 PropertyValidationException(
        final PropertyDescriptor propertyDescriptor,
        final List<? extends PropertyConstraint<?>> constraints,
        final Object value)
    {
      this(createMessage(propertyDescriptor, constraints, value),
          propertyDescriptor, constraints, value);
    }
  
    /**
     * Convenience constructor with no root cause.
     *
     * @param message the detail message (which is saved for later retrieval by
     *          the {@link #getMessage()} method).
     * @param propertyDescriptor the descriptor of the property raising the
     *          exception.
     * @param constraints the property constraints that failed to be met.
     * @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 PropertyValidationException(final String message,
        final PropertyDescriptor propertyDescriptor,
        final List<? extends PropertyConstraint<?>> constraints,
        final Object value)
    {
      this(message, null, propertyDescriptor, constraints, value);
    }
  
    /**
     * 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 constraints the property constraints that failed to be met.
    * @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 PropertyValidationException(final Throwable cause,
       final PropertyDescriptor propertyDescriptor,
       final List<? extends PropertyConstraint<?>> constraints,
       final Object value)
   {
     this(null, cause, propertyDescriptor, constraints, value);
   }
 
   /**
    * 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 constraints the property constraints that failed to be met.
    * @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 PropertyValidationException(final String message,
       final Throwable cause, final PropertyDescriptor propertyDescriptor,
       final List<? extends PropertyConstraint<?>> constraints,
       final Object value)
   {
     super(message, cause, propertyDescriptor);
 
     this.constraints = constraints;
     this.value =
         value instanceof Serializable ? (Serializable) value : String
             .valueOf(value);
   }
 
   // ****************************** Inner Classes *****************************
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   private static String createMessage(
       final PropertyDescriptor propertyDescriptor,
       final List<? extends PropertyConstraint<?>> constraints,
       final Object value)
   {
     final StringBuilder buffer = new StringBuilder();
 
     buffer.append("Invalid value '"
                   + value
                   + '\''
                   + (value != null ? " (" + value.getClass().getSimpleName()
                                      + ')' : "") + " for property '"
                   + propertyDescriptor.getKey() + "':");
     if (constraints != null && !constraints.isEmpty())
     {
       for (final PropertyConstraint<?> constraint : constraints)
       {
         buffer.append('\n').append(constraint.getDescription());
       }
     }
 
     return buffer.toString();
   }
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the property constraint that failed to be met.
    *
    * @return the property constraint that failed to be met.
    */
   public final List<? extends PropertyConstraint<?>> getConstraints()
   {
     return constraints;
   }
 
   /**
    * 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 --------------------------------------------------------
 
 }