/*
    * 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.config.domain;
  
  import java.util.Collections;
  import java.util.List;
  
  import de.smartics.properties.api.config.domain.key.ConfigurationKey;
  import de.smartics.properties.api.core.domain.PropertyDescriptor;
  import de.smartics.properties.api.core.domain.PropertyException;
  
  /**
   * Signals that the configuration is invalid or at least properties cannot be
   * validated because there are no properties descriptors registered for them.
   *
   * @impl Note that the message text is not part of the public API and may change
   *       without notice.
   */
  public class ConfigurationValidationException extends ConfigurationException
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     * <p>
     * The value of this constant is {@value}.
     */
    private static final long serialVersionUID = 1L;
  
    // --- members --------------------------------------------------------------
  
    /**
     * The list of violations.
     *
     * @serial
     */
    private final List<PropertyException> propertyViolations;
  
    /**
     * The list of mandatory properties for which no value has been provided.
     *
     * @serial
     */
    private final List<PropertyDescriptor> mandatoryProperties;
  
    /**
     * The list of unknown properties.
     *
     * @serial
     */
    private final UnknownProperties unknownProperties;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Convenience constructor without root cause.
     *
     * @param key the key to the configuration that signaled problems.
     * @param propertyViolations the list of violations.
     * @param mandatoryProperties the list of mandatory properties for which no
     *          value has been provided.
     * @param unknownProperties the list of unknown properties.
     */
    public ConfigurationValidationException(final ConfigurationKey key,
        final List<PropertyException> propertyViolations,
        final List<PropertyDescriptor> mandatoryProperties,
        final UnknownProperties unknownProperties)
    {
      this(null, key, propertyViolations, mandatoryProperties, unknownProperties);
    }
  
    /**
     * 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 key the key to the configuration that signaled problems.
     * @param propertyViolations the list of violations.
     * @param mandatoryProperties the list of mandatory properties for which no
     *          value has been provided.
     * @param unknownProperties the list of unknown properties.
    */
   public ConfigurationValidationException(final Throwable cause,
       final ConfigurationKey key,
       final List<PropertyException> propertyViolations,
       final List<PropertyDescriptor> mandatoryProperties,
       final UnknownProperties unknownProperties)
   {
     super(createMessage(key, propertyViolations, mandatoryProperties,
         unknownProperties), cause, key);
     this.propertyViolations = propertyViolations;
     this.mandatoryProperties = mandatoryProperties;
     this.unknownProperties = unknownProperties;
   }
 
   // ****************************** Inner Classes *****************************
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   private static String createMessage(final ConfigurationKey key,
       final List<PropertyException> propertyViolations,
       final List<PropertyDescriptor> mandatoryProperties,
       final UnknownProperties unknownProperties)
   {
     final StringBuilder buffer = new StringBuilder();
     buffer.append("Configuration '" + key + "' is invalid.\n");
 
     addViolations(propertyViolations, buffer);
     addMandatoryProperties(mandatoryProperties, buffer);
     addUnknownProperties(unknownProperties, buffer);
 
     return buffer.toString();
   }
 
   private static void addViolations(
       final List<PropertyException> propertyViolations,
       final StringBuilder buffer)
   {
     if (propertyViolations != null && !propertyViolations.isEmpty())
     {
       buffer.append("The following violations have been reported:\n");
       for (final PropertyException violation : propertyViolations)
       {
         buffer.append("  ").append(violation.getMessage()).append('\n');
       }
     }
   }
 
   private static void addMandatoryProperties(
       final List<PropertyDescriptor> mandatoryProperties,
       final StringBuilder buffer)
   {
     if (mandatoryProperties != null && !mandatoryProperties.isEmpty())
     {
       buffer
           .append("The following mandatory properties have not been provided:\n");
       for (final PropertyDescriptor descriptor : mandatoryProperties)
       {
         buffer.append("  ").append(descriptor.getKey()).append('\n');
       }
     }
   }
 
   private static void addUnknownProperties(
       final UnknownProperties unknownProperties, final StringBuilder buffer)
   {
     if (unknownProperties != null && !unknownProperties.isEmpty())
     {
       buffer.append("The following unknown properties have been reported:\n");
       for (final Property property : unknownProperties.getProperties())
       {
         buffer.append("  ").append(property).append('\n');
       }
     }
   }
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the list of violations.
    *
    * @return the list of violations.
    */
   public final List<PropertyException> getPropertyViolations()
   {
     return Collections.unmodifiableList(propertyViolations);
   }
 
   /**
    * Returns the list of mandatory properties for which no value has been
    * provided.
    *
    * @return the list of mandatory properties for which no value has been
    *         provided.
    */
   public final List<PropertyDescriptor> getMandatoryProperties()
   {
     return Collections.unmodifiableList(mandatoryProperties);
   }
 
   /**
    * Returns the list of unknown properties.
    *
    * @return the list of unknown properties.
    */
   public final UnknownProperties getUnknownProperties()
   {
     return unknownProperties;
   }
 
   // --- business -------------------------------------------------------------
 
   // --- object basics --------------------------------------------------------
 }