/*

  * 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;

 import de.smartics.exceptions.i18n.message.MessageParam;

 import de.smartics.properties.api.core.app.PropertyRootException;

 /**

  * Signals that a set of property descriptor has been encountered twice.

  */

 public class DuplicatePropertyDeclarationsException 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 list of property declarations of declaration collisions. This is where

    * two interfaces declare properties with identical keys.

    *

    * @serial

    */

   private final List<DuplicatePropertyDeclarationException> exceptions;

   /**

    * The summary of exception.

    *

    * @serial

    */

   @MessageParam

   private final String exceptionsMessage; // NOPMD

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

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

   /**

    * Default constructor.

    *

    * @param exceptions the list of property declarations of declaration

    *          collisions.

    */

   public DuplicatePropertyDeclarationsException(

       final List<DuplicatePropertyDeclarationException> exceptions)

   {

     super(PropertyCode.DUPLICATE_DECLARATIONS);

     this.exceptions = exceptions;

     this.exceptionsMessage = createMessage(exceptions);

   }

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

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

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

   private static String createMessage(

       final List<DuplicatePropertyDeclarationException> exceptions)

   {

     final StringBuilder buffer = new StringBuilder(128);

     for (final DuplicatePropertyDeclarationException e : exceptions)

     {

       buffer.append("\n  ").append(e.getLocalizedMessage());

     }

     return buffer.toString();

   }

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

   /**

    * Returns the list of property declarations of declaration collisions. This

    * is where two interfaces declare properties with identical keys.

    *

    * @return the list of property declarations of declaration collisions.

    */

   public final List<DuplicatePropertyDeclarationException> getExceptions()

   {

     return exceptions;

   }

   /**

    * Returns the count of duplicate property declarations.

    *

    * @return the count of duplicate property declarations.

    */

   @MessageParam("duplicateCount")

   public final int getDuplicateCount()

   {

     return exceptions.size();

   }

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

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

 }