/*
    * Copyright 2007-2011 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.exceptions.i18n.app;
  
  import de.smartics.exceptions.code.NumberCode;
  import de.smartics.exceptions.code.NumberCodeInfo;
  
  /**
   * Defines the parsing exception codes for this package.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  public enum ParseExceptionCode implements NumberCode
  {
    // ****************************** Enumeration *******************************
  
    /**
     * The generic parsing error.
     */
    GENERIC(2000),
  
    /**
     * Parsing an OGNL path expression failed.
     */
    OGNL(2000, 1),
  
    /**
     * Parsing the value for a parent attribute failed because the <code>=</code>
     * -sign is missing. The <code>=</code>-sign separates the attribute name from
     * the index information.
     * <p>
     * The parent attribute is an attribute specified by the super class of an
     * exception. The parent exception may be of a standard library and therefore
     * cannot be annotated so the annotation is placed in the subclass.
     * </p>
     */
    MISSING_PARENT_PROPERTY_SEPARATOR(2000, 2),
  
    /**
     * Parsing the value for a parent attribute failed because the attribute in
     * front of the <code>=</code>-sign is missing.
     * <p>
     * The parent attribute is an attribute specified by the super class of an
     * exception. The parent exception may be of a standard library and therefore
     * cannot be annotated so the annotation is placed in the subclass.
     * </p>
     */
    MISSING_PARENT_PROPERTY_ATTRIBUTE(2000, 3),
  
    /**
     * Parsing the value for a parent attribute failed because the index after the
     * <code>=</code>-sign is missing.
     * <p>
     * The parent attribute is an attribute specified by the super class of an
     * exception. The parent exception may be of a standard library and therefore
     * cannot be annotated so the annotation is placed in the subclass.
     * </p>
     */
    MISSING_PARENT_PROPERTY_INDEX(2000, 4);
  
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The code information.
     */
    private final NumberCodeInfo info;
  
    // ****************************** Constructors ******************************
  
    /**
     * Convenience constructor.
     *
     * @param majorNumber the major part of the error code.
     */
    private ParseExceptionCode(final Integer majorNumber)
    {
      this(majorNumber, null);
    }
  
    /**
     * Convenience constructor.
    *
    * @param majorNumber the major part of the error code.
    * @param minorNumber the minor part of the error code.
    */
   private ParseExceptionCode(final Integer majorNumber,
       final Integer minorNumber)
   {
     this(readComponentId(), majorNumber, minorNumber);
   }
 
   /**
    * Default constructor.
    *
    * @param componentId the component identifier.
    * @param majorNumber the major part of the error code.
    * @param minorNumber the minor part of the error code.
    */
   private ParseExceptionCode(final String componentId,
       final Integer majorNumber, final Integer minorNumber)
   {
     this.info = new NumberCodeInfo(componentId, majorNumber, minorNumber);
   }
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   /**
    * Used to access the identify for the exceptions raised by this component.
    *
    * @return the component identifier of this exception library.
    */
   private static String readComponentId()
   {
     return Constant.COMPONENT_ID;
   }
 
   // --- get&set --------------------------------------------------------------
 
   // --- business -------------------------------------------------------------
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.core.Code#getCode()
    */
   public String getCode()
   {
     return info.getCode();
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.core.Code#getComponentId()
    */
   public String getComponentId()
   {
     return info.getComponentId();
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.code.NumberCode#getMajorNumber()
    */
   public Integer getMajorNumber()
   {
     return info.getMajorNumber();
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.code.NumberCode#getMinorNumber()
    */
   public Integer getMinorNumber()
   {
     return info.getMinorNumber();
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.core.Code#getDisplayId()
    */
   public String getDisplayId()
   {
     return info.getDisplayId();
   }
 
   // --- object basics --------------------------------------------------------
 
   /**
    * Returns the string representation of the object.
    *
    * @return the string representation of the object.
    */
   @Override
   public String toString()
   {
     return info.toString();
   }
 }