systemerror.java

jworks program

package org.softme.util;

/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2001 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 acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *    "Apache Turbine" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact [e-mail].
 *
 * 5. Products derived from this software may not be called "Apache",
 *    "Apache Turbine", nor may "Apache" appear in their name, 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.ByteArrayOutputStream;
import java.io.PrintWriter;

/**
 * Used for wrapping system errors (exceptions) that may occur in the
 * application.
 *
 * @author <a href="mailto:[e-mail]">Neeme Praks</a>
 * @version $Id: SystemError.java,v 1.1.1.1 2004/08/20 05:57:59 brokendoor Exp $
 */
public class SystemError
{
    private Exception e;
    private String message;

    /**
     * Constructor.
     *
     * @param e An Exception.
     */
    public SystemError(Exception e)
    {
        setMessage(e.getMessage());
        setException(e);
    }

    /**
     * Constructor.
     *
     * @param e An Exception.
     * @param message A String.
     */
    public SystemError(Exception e, String message)
    {
        this(e);
        setMessage(message);
    }

    /**
     * Constructor.
     *
     * @param e An Exception.
     * @param returncode A long.
     */
    public SystemError(Exception e, long returncode)
    {
        this(e, new Long(returncode).toString());
    }

    /**
     * Get the message.
     *
     * @return A String.
     */
    public String getMessage()
    {
        return message;
    }

    /**
     * Set the message.
     *
     * @param message A String.
     */
    public void setMessage(String message)
    {
        this.message = message;
    }

    /**
     * Get the exception.
     *
     * @return An Exception.
     */
    public Exception getException()
    {
        return e;
    }

    /**
     * Set the exception.
     *
     * @param e An Exception.
     */
    public void setException(Exception e)
    {
        this.e = e;
    }

    /**
     * Get the stack trace.
     *
     * @return A String.
     */
    public String getStackTrace()
    {
        if (e != null)
        {
            ByteArrayOutputStream out = new ByteArrayOutputStream();
            e.printStackTrace(new PrintWriter(out,true));
            return out.toString();
        }
        else
        {
            return "";
        }
    }
}