/*
    * 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 java.util.Locale;
  
  import de.smartics.exceptions.i18n.message.MessageParam;
  import de.smartics.properties.api.core.annotations.AccessType;
  import de.smartics.properties.api.core.annotations.PropertyDefinitionTime;
  import de.smartics.properties.api.core.annotations.PropertyUse.UseType;
  import de.smartics.properties.api.core.app.PropertiesCode;
  
  /**
   * Provides context information for errors concerning a property.
   */
  public class PropertyDescriptorMessageBean extends PropertyMessageBean
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     * <p>
     * The value of this constant is {@value}.
     * </p>
     */
    private static final long serialVersionUID = 1L;
  
    // --- members --------------------------------------------------------------
  
    /**
     * The descriptor of the property raising the exception.
     *
     * @serial
     */
    @MessageParam("propertyDescriptorDeclaringType:declaringType,propertyKey:key")
    private final PropertyDescriptor propertyDescriptor;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param code the error or exception code of the exception.
     * @param cause the cause to the problem.
     * @param propertyDescriptor the descriptor of the property raising the
     *          exception.
     */
    public PropertyDescriptorMessageBean(final PropertiesCode code,
        final Throwable cause, final PropertyDescriptor propertyDescriptor)
    {
      super(code, cause, provide(propertyDescriptor).getKey());
      this.propertyDescriptor = provide(propertyDescriptor);
    }
  
    // ****************************** Inner Classes *****************************
  
    /**
     * Null object for rendering.
     */
    private static final class DefaultPropertyDescriptor implements
        PropertyDescriptor
    {
      /**
       * The class version identifier.
       * <p>
       * The value of this constant is {@value}.
       * </p>
       */
      private static final long serialVersionUID = 1L;
  
      @Override
      public PropertyContext getContext()
      {
        return null;
      }
  
      @Override
      public Class<?> getDeclaringType()
      {
        return Void.class;
      }
 
     @Override
     public PropertyKey getKey()
     {
       return new PropertyKey("n/a");
     }
 
     @Override
     public PropertyType getType()
     {
       return null;
     }
 
     @Override
     public boolean isMandatory()
     {
       return false;
     }
 
     @Override
     public boolean isSecured()
     {
       return false;
     }
 
     @Override
     public AccessType getAccessType()
     {
       return null;
     }
 
     @Override
     public boolean isRuntimeMutable()
     {
       return false;
     }
 
     @Override
     public long getUpdateIntervalInMs()
     {
       return 0;
     }
 
     @Override
     public PropertyDefinitionTime getConfigurationTime()
     {
       return null;
     }
 
     @Override
     public PropertyExpression getDefaultExpression()
     {
       return null;
     }
 
     @Override
     public PropertyValueRange<?> getValueRange()
     {
       return null;
     }
 
     @Override
     public List<? extends PropertyConstraint<?>> getConstraints()
     {
       return null;
     }
 
     @Override
     public DocumentName getDocumentName()
     {
       return null;
     }
 
     @Override
     public PropertyProjectdoc getDocumentMetaData()
     {
       return null;
     }
 
     @Override
     public PropertyProjectdoc getDocumentMetaData(final Locale locale)
     {
       return null;
     }
 
     @Override
     public PropertySetProjectdoc getDocumentMetaDataProjectSet()
     {
       return null;
     }
 
     @Override
     public PropertySetProjectdoc getDocumentMetaDataProjectSet(
         final Locale locale)
     {
       return null;
     }
 
     @Override
     public PropertyComment getComment()
     {
       return null;
     }
 
     @Override
     public PropertyComment getComment(final Locale locale)
     {
       return null;
     }
 
     @Override
     public PropertyCategories getCategories()
     {
       return null;
     }
 
     @Override
     public UseType getUseType()
     {
       return null;
     }
   }
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   private static PropertyDescriptor provide(
       final PropertyDescriptor propertyDescriptor)
   {
     return propertyDescriptor != null ? propertyDescriptor
         : new DefaultPropertyDescriptor();
   }
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the descriptor of the property raising the exception.
    *
    * @return the descriptor of the property raising the exception.
    */
   public final PropertyDescriptor getPropertyDescriptor()
   {
     return propertyDescriptor;
   }
 
   // --- business -------------------------------------------------------------
 
   // --- object basics --------------------------------------------------------
 
 }