/*

  * 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.spi.core.constraint;

 import java.util.Collections;

 import java.util.Locale;

 import de.smartics.properties.api.core.domain.PropertyConstraint;

 import de.smartics.properties.api.core.domain.PropertyDescriptor;

 import de.smartics.properties.api.core.domain.PropertyValidationException;

 /**

  * Base implementation of the {@link PropertyConstraint} interface.

  *

  * @param <T> the type of the property value.

  */

 public abstract class AbstractPropertyConstraint<T> implements

     PropertyConstraint<T>

 {

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

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

   /**

    * The class version identifier.

    */

   private static final long serialVersionUID = 1L;

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

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

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

   /**

    * Default constructor.

    */

   protected AbstractPropertyConstraint()

   {

   }

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

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

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

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

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

   // CHECKSTYLE:OFF

   @Override

   public boolean isMandatoryConstraint() // CHECKSTYLE:ON

   {

     return false;

   }

   @Override

   public final String getDescription()

   {

     return getDescription(Locale.getDefault());

   }

   @Override

   public String getViolationMessage(final Locale locale,

       final Object actualValue)

   {

     return actualValue + ": " + getDescription(locale);

   }

   @Override

   public boolean isValid(final T value)

   {

     return isValid(value, null);

   }

   @Override

   public final void validate(final PropertyDescriptor propertyDescriptor,

       final T value) throws PropertyValidationException

   {

     validate(propertyDescriptor, value, null);

   }

   @Override

   public final void validate(final PropertyDescriptor propertyDescriptor,

       final T value, final Class<?> group) throws PropertyValidationException

   {

     final boolean valid = isValid(value, group);

     if (!valid)

     {

       throw PropertyValidationException.invalid(propertyDescriptor,

           Collections.singletonList(this), value);

     }

   }

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

   /**

    * Returns the string representation of the object.

    *

    * @return the string representation of the object.

    */

   // CHECKSTYLE:OFF

   @Override

   public String toString() // CHECKSTYLE:ON

   {

     return getDescription();

   }

 }