/*
    * 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;
  
  import java.util.Date;
  
  import de.smartics.exceptions.core.Code;
  import de.smartics.exceptions.core.ExceptionId;
  import de.smartics.exceptions.core.ThrowableHandleMode;
  
  /**
   * The base implementation of the core runtime exception that supports unique
   * identifying and exception codes for unchecked exceptions.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision$
   */
  public abstract class AbstractCoreRuntimeException extends RuntimeException
      implements CoreException
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     */
    private static final long serialVersionUID = 4L;
  
    // --- members --------------------------------------------------------------
  
    /**
     * Reference to common exception information. Currently this is the exception
     * identifier and the exception code.
     *
     * @serial
     */
    protected final ExceptionInfo info; // NOPMD
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Constructor.
     *
     * @param code the error or exception code of the exception.
     * @see AbstractCoreRuntimeException#AbstractCoreRuntimeException(String,
     *      Throwable, Code)
     */
    protected AbstractCoreRuntimeException(final Code code)
    {
      this(null, null, code);
    }
  
    /**
     * Constructor.
     *
     * @param message the detail message (which is saved for later retrieval by
     *          the {@link #getMessage()} method). Only used if there is no
     *          localised message in the bundle.
     * @param code the error or exception code of the exception.
     * @see AbstractCoreRuntimeException#AbstractCoreRuntimeException(String,
     *      Throwable, Code)
     */
    protected AbstractCoreRuntimeException(final String message, final Code code)
    {
      this(message, null, code);
    }
  
    /**
     * 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 code the error or exception code of the exception.
     * @see AbstractCoreRuntimeException#AbstractCoreRuntimeException(String,
     *      Throwable, Code)
     */
    protected AbstractCoreRuntimeException(final Throwable cause, final Code code)
    {
      this(null, cause, code);
    }
  
    /**
    * Constructor.
    *
    * @param message the detail message (which is saved for later retrieval by
    *          the {@link #getMessage()} method). Only used if there is no
    *          localised message in the bundle.
    * @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 code the error or exception code of the exception.
    * @throws NullPointerException if the code is <code>null</code>.
    * @see java.lang.RuntimeException#RuntimeException(java.lang.String,java.lang.Throwable)
    */
   protected AbstractCoreRuntimeException(final String message,
       final Throwable cause, final Code code) throws NullPointerException
   {
     super(message, Helper.provideException(cause));
     this.info = new ExceptionInfo(cause, code);
   }
 
   // ****************************** Inner Classes *****************************
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the unique identifier of the exception. The identifier is used to
    * track an exception in different tiers.
    * <p>
    * This identifier must never be <code>null</code>.
    *
    * @return the unique identifier of the exception.
    */
   public ExceptionId<?> getId()
   {
     return info.getId();
   }
 
   /**
    * Returns the error or exception code of the exception.
    * <p>
    * This code must never be <code>null</code>.
    *
    * @return the error or exception code of the exception.
    */
   public Code getCode()
   {
     return info.getCode();
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.CoreException#getTime()
    */
   public Date getTime()
   {
     return info.getTime();
   }
 
   /**
    * {@inheritDoc}
    *
    * @see java.lang.Throwable#getCause()
    */
   @Override
   public Throwable getCause()
   {
     if (Helper.getThrowableHandleMode() == ThrowableHandleMode.NORMAL)
     {
       return super.getCause();
     }
     else
     {
       return info.removeableCause;
     }
   }
 
   // --- business -------------------------------------------------------------
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.CoreException#truncateCause()
    */
   public void truncateCause()
   {
     Helper.truncateCause(this, this.info);
   }
 
   // --- object basics --------------------------------------------------------
 
   /**
    * Returns the string representation of the object for debugging.
    *
    * @return the string representation of the object.
    */
   public String toString()
   {
     final StringBuilder buffer = new StringBuilder();
     final String message = getLocalizedMessage();
     buffer.append(this.info);
     if (message != null)
     {
       buffer.append(": ").append(message);
     }
 
     return buffer.toString();
   }
 }