/*

  * 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.context.alias;

 /**

  * Signals that an alias points to two different physical resources.

  */

 public final class DuplicateAliasException extends AliasException

 {

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

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

   /**

    * The class version identifier.

    * <p>

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

    * </p>

    */

   private static final long serialVersionUID = 1L;

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

   /**

    * The physical value stored with the alias.

    *

    * @serial

    */

   private final String oldTarget;

   /**

    * The new physical value that differs from the previously stored.

    *

    * @serial

    */

   private final String newTarget;

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

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

   /**

    * Convenience constructor without a cause.

    *

    * @param alias the alias that signals a problem.

    * @param oldTarget the target value stored with the alias.

    * @param newTarget the new target value that differs from the previously

    *          stored.

    */

   public DuplicateAliasException(final String alias, final String oldTarget,

       final String newTarget)

   {

     this(null, alias, oldTarget, newTarget);

   }

   /**

    * Default 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 alias the alias that signals a problem.

    * @param oldTarget the target value stored with the alias.

    * @param newTarget the new target value that differs from the previously

    *          stored.

    */

   public DuplicateAliasException(final Throwable cause, final String alias,

       final String oldTarget, final String newTarget)

   {

     super("Duplicate alias '" + alias + "' with contradicting targets found: '"

           + newTarget + "' replaced '" + oldTarget + "'.", cause, alias);

     this.oldTarget = oldTarget;

     this.newTarget = newTarget;

   }

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

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

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

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

   /**

    * Returns the target value stored with the alias.

    *

    * @return the target value stored with the alias.

    */

   public String getOldTarget()

   {

     return oldTarget;

   }

   /**

    * Returns the new target value that differs from the previously stored.

    *

    * @return the new target value that differs from the previously stored.

    */

   public String getNewTarget()

   {

     return newTarget;

   }

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

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

 }