/*

  * 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.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}.

    * </p>

    */

   private static final long serialVersionUID = 1L;

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

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

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

   /**

    * Default constructor.

    *

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

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

    */

   public PropertyValidationException(final PropertyValidationMessageBean message)

   {

     super(message);

   }

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

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

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

   // --- factory --------------------------------------------------------------

   /**

    * Creates an instance of the validation exception.

    *

    * @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.

    * @return the created exception instance.

    */

   public static final PropertyValidationException invalid(

       final PropertyDescriptor propertyDescriptor,

       final List<? extends PropertyConstraint<?>> constraints, final Object value)

   {

     return new PropertyValidationException(new PropertyValidationMessageBean(

         propertyDescriptor, constraints, value));

   }

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

   @Override

   public final PropertyValidationMessageBean getMessageBean()

   {

     return (PropertyValidationMessageBean) super.getMessageBean();

   }

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

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

 }