/*******************************************************************************
 * Copyright (c) 2000, 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
// Port to the D programming language:
//     Frank Benoit <benoit@tionex.de>
module org.eclipse.core.runtimeCoreException;

import java.lang.all;

import org.eclipse.core.runtimeStatus; // packageimport
import org.eclipse.core.runtimeIStatus; // packageimport

import java.io.PrintStream;
import java.io.PrintWriter;

import org.eclipse.core.internal.runtime.PrintStackUtil;

/**
 * A checked exception representing a failure.
 * <p>
 * Core exceptions contain a status object describing the 
 * cause of the exception.
 * </p><p>
 * This class can be used without OSGi running.
 * </p>
 * @see IStatus
 */
public class CoreException : Exception {

    /**
     * All serializable objects should have a stable serialVersionUID
     */
    private static final long serialVersionUID = 1L;

    /** Status object. */
    private IStatus status;

    /**
     * Creates a new exception with the given status object.  The message
     * of the given status is used as the exception message.
     *
     * @param status the status object to be associated with this exception
     */
    public this(IStatus status) {
        super(status.getMessage());
        this.status = status;
    }

    /**
      * Returns the cause of this exception, or <code>null</code> if none.
      * 
      * @return the cause for this exception
      * @since 3.4
      */
    public Throwable getCause() {
        return status.getException();
    }

    /**
     * Returns the status object for this exception.
     * <p>
     *   <b>IMPORTANT:</b><br>
     *   The result must NOT be used to log a <code>CoreException</code>
     *   (e.g., using <code>yourPlugin.getLog().log(status);</code>),
     *   since that code pattern hides the original stacktrace.
     *   Instead, create a new {@link Status} with your plug-in ID and
     *   this <code>CoreException</code>, and log that new status.
     * </p>
     *
     * @return a status object
     */
    public final IStatus getStatus() {
        return status;
    }

    /**
     * Prints a stack trace out for the exception, and
     * any nested exception that it may have embedded in
     * its Status object.
     */
    public void printStackTrace() {
        printStackTrace(System.err);
    }

    /**
     * Prints a stack trace out for the exception, and
     * any nested exception that it may have embedded in
     * its Status object.
     * 
     * @param output the stream to write to
     */
    public void printStackTrace(PrintStream output) {
        synchronized (output) {
            super.printStackTrace(output);
            PrintStackUtil.printChildren(status, output);
        }
    }

    /**
     * Prints a stack trace out for the exception, and
     * any nested exception that it may have embedded in
     * its Status object.
     * 
     * @param output the stream to write to
     */
    public void printStackTrace(PrintWriter output) {
        synchronized (output) {
            super.printStackTrace(output);
            PrintStackUtil.printChildren(status, output);
        }
    }
}