/*

  * 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 de.smartics.properties.api.core.app.PropertyRootException;

 /**

  * Base exception of the library for signaling an unspecific cause that is

  * concerned with a specific property.

  */

 public class PropertyException extends PropertyRootException

 {

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

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

   /**

    * The class version identifier.

    * <p>

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

    * </p>

    */

   private static final long serialVersionUID = 1L;

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

   /**

    * The key of the property raising the exception.

    *

    * @serial

    */

   private final PropertyKey propertyKey;

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

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

   /**

    * 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 propertyKey the key of the property raising the exception.

    * @see java.lang.RuntimeException#RuntimeException(java.lang.String,java.lang.Throwable)

    */

   public PropertyException(final String message, final Throwable cause,

       final PropertyKey propertyKey)

   {

     super(message, cause);

     this.propertyKey = propertyKey;

   }

   /**

    * Convenience constructor.

    *

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

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

    * @param propertyKey the key of the property raising the exception.

    * @see java.lang.RuntimeException#RuntimeException(java.lang.String,java.lang.Throwable)

    */

   public PropertyException(final String message, final PropertyKey propertyKey)

   {

     this(message, null, propertyKey);

   }

   /**

    * Convenience 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 propertyKey the key of the property raising the exception.

    * @see java.lang.RuntimeException#RuntimeException(java.lang.String,java.lang.Throwable)

    */

   public PropertyException(final Throwable cause, final PropertyKey propertyKey)

   {

     this(null, cause, propertyKey);

   }

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

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

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

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

   /**

    * Returns the key of the property raising the exception.

    *

    * @return the key of the property raising the exception.

    */

   public final PropertyKey getPropertyKey()

   {

     return propertyKey;

   }

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

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

 }