/*
    * 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.code;
  
  /**
   * This {@link de.smartics.exceptions.core.Code} implementation models the
   * exception code as a number. It supports a component identifier as an
   * arbitrary string and provides a facility to specify the number as a major an
   * minor number that will be added.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  public class NumberCodeInfo implements NumberCode
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     * <p>
     * The value of this constant is {@value}.
     */
    private static final long serialVersionUID = 1L;
  
    // --- members --------------------------------------------------------------
  
    /**
     * The identifier of the component this code belongs to.
     *
     * @serial
     */
    protected final String componentId;
  
    /**
     * The major number of the code defines a group of codes. This group is
     * associated with a certain type of problem within the component.
     * <p>
     * For example HTTP knows the major numbers 100, 200, 300, 400, etc.
     *
     * @serial
     */
    protected final Integer majorNumber;
  
    /**
     * The minor number gives additional information about the problem. It
     * specifies exactly the type of problem. If this value is <code>null</code>,
     * there is no minor number specified.
     * <p>
     * For example HTTP knows the minor number 4 for page not found. This will add
     * with the major number to 404.
     */
    protected final Integer minorNumber;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Convenience constructor.
     *
     * @param majorNumber the major number of the code defines a group of codes.
     */
    public NumberCodeInfo(final Integer majorNumber)
    {
      this(null, majorNumber);
    }
  
    /**
     * Convenience constructor.
     *
     * @param componentId the identifier of the component this code belongs to.
     * @param majorNumber the major number of the code defines a group of codes.
     */
    public NumberCodeInfo(final String componentId, final Integer majorNumber)
    {
      this(componentId, majorNumber, null);
    }
  
    /**
     * Default constructor.
     *
     * @param componentId the identifier of the component this code belongs to.
     * @param majorNumber the major number of the code defines a group of codes.
     * @param minorNumber the minor number gives additional information about the
    *          problem.
    * @throws NullPointerException if the major number is <code>null</code>.
    */
   public NumberCodeInfo(final String componentId, final Integer majorNumber,
       final Integer minorNumber) throws NullPointerException
   {
     if (majorNumber == null)
     {
       throw new NullPointerException("Major number must not be 'null'.");
     }
     this.componentId = componentId;
     this.majorNumber = majorNumber;
     this.minorNumber = minorNumber;
   }
 
   // ****************************** Inner Classes *****************************
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the identifier of the component this code belongs to.
    *
    * @return the identifier of the component this code belongs to.
    */
   public String getComponentId()
   {
     return componentId;
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.code.NumberCode#getMajorNumber()
    */
   public Integer getMajorNumber()
   {
     return majorNumber;
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.code.NumberCode#getMinorNumber()
    */
   public Integer getMinorNumber()
   {
     return minorNumber;
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.core.Code#getDisplayId()
    */
   public String getDisplayId()
   {
     final String code = getCode();
 
     final StringBuilder buffer = new StringBuilder();
 
     if (componentId != null)
     {
       buffer.append(componentId).append('-');
     }
     buffer.append(code);
 
     return buffer.toString();
   }
 
   // --- business -------------------------------------------------------------
 
   /**
    * {@inheritDoc}
    */
   // @Override
   public String getCode()
   {
     int number = majorNumber.intValue();
     if (minorNumber != null)
     {
       number += minorNumber.intValue();
     }
 
     return String.valueOf(number);
   }
 
   // --- object basics --------------------------------------------------------
 
   /**
    * Returns the string representation of the object.
    *
    * @return the string representation of the object.
    */
   @Override
   public String toString()
   {
     return getDisplayId();
   }
 
 }