package org.apache.commons.lang.exception;

/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2002 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

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

/**
 * 他の例外を内部に持つことのできる全てのエラーのベースクラスです。
 * {@primary The base class of all errors which can contain other exceptions.}
 *
 * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
 * @translator 日置 聡
 * @status firstdraft
 * @update 2003/08/05
 * @see org.apache.commons.lang.exception.NestableException
 * @since 1.0
 */
public class NestableError extends Error implements Nestable
{
    /**
     * 委譲された多くの処理をもつヘルパーインスタンス。
     * {@primary The helper instance which contains much of the code which we
     * delegate to.}
     */
    protected NestableDelegate delegate = new NestableDelegate(this);

    /**
     * この例外が投げられる原因となった例外またはエラーの参照を保持します。
     * {@primary Holds the reference to the exception or error that caused
     * this exception to be thrown.}
     */
    private Throwable cause = null;

    /**
    /**
     * 詳細メッセージを設定せずに新たな <code>NestableError</code> を生成します。
     * {@primary Constructs a new <code>NestableError</code> without specified
     * detail message.}
     */
    public NestableError()
    {
        super();
    }

    /**
     * 詳細メッセージを設定して新たな <code>NestableError</code> を生成します。
     * {@primary Constructs a new <code>NestableError</code> with specified
     * detail message.}
     *
     * @param msg エラーメッセージ
     * {@primary The error message.}
     */
    public NestableError(String msg)
    {
        super(msg);
    }

    /**
     * 原因となる <code>Throwable</code> を設定して新たな <code>NestableError</code> を生成します。
     * {@primary Constructs a new <code>NestableError</code> with specified
     * nested <code>Throwable</code>.}
     *
     * @param cause この例外が投げられる原因となった例外またはエラー
     * {@primary the exception or error that caused this exception to be
     * thrown}
     */
    public NestableError(Throwable cause)
    {
        super();
        this.cause = cause;
    }

    /**
     * 詳細メッセージと原因となる <code>Throwable</code> 
     * を設定して新たな <code>NestableError</code> を生成します。
     * {@primary Constructs a new <code>NestableError</code> with specified
     * detail message and nested <code>Throwable</code>.}
     *
     * @param msg エラーメッセージ
     * {@primary The error message.}
     * @param cause この例外が投げられる原因となった例外またはエラー
     * {@primary the exception or error that caused this exception to be
     * thrown}
     */
    public NestableError(String msg, Throwable cause)
    {
        super(msg);
        this.cause = cause;
    }

    public Throwable getCause()
    {
        return cause;
    }

    public String getMessage()
    {
        return delegate.getMessage(super.getMessage());
    }

    public String getMessage(int index)
    {
        if (index == 0)
        {
            return super.getMessage();
        }
        else
        {
            return delegate.getMessage(index);
        }
    }
    
    public String[] getMessages()
    {
        return delegate.getMessages();
    }
    
    public Throwable getThrowable(int index)
    {
        return delegate.getThrowable(index);
    }
    
    public int getThrowableCount()
    {
        return delegate.getThrowableCount();
    }
    
    public Throwable[] getThrowables()
    {
        return delegate.getThrowables();
    }
    
    public int indexOfThrowable(Class type)
    {
        return delegate.indexOfThrowable(type, 0);
    }

    public int indexOfThrowable(Class type, int fromIndex)
    {
        return delegate.indexOfThrowable(type, fromIndex);
    }

    public void printStackTrace()
    {
        delegate.printStackTrace();
    }

    public void printStackTrace(PrintStream out)
    {
        delegate.printStackTrace(out);
    }

    public void printStackTrace(PrintWriter out)
    {
        delegate.printStackTrace(out);
    }

    public final void printPartialStackTrace(PrintWriter out)
    {
        super.printStackTrace(out);
    }
}