head	1.1;
access;
symbols
	HELM_PEER_PORT_BRANCH:1.1.0.2;
locks; strict;
comment	@# @;


1.1
date	2001.02.02.22.35.59;	author dlr;	state dead;
branches
	1.1.2.1;
next	;

1.1.2.1
date	2001.02.02.22.35.59;	author dlr;	state Exp;
branches;
next	1.1.2.2;

1.1.2.2
date	2001.02.02.22.44.00;	author dlr;	state Exp;
branches;
next	1.1.2.3;

1.1.2.3
date	2001.02.02.23.11.40;	author dlr;	state Exp;
branches;
next	1.1.2.4;

1.1.2.4
date	2001.02.05.14.55.20;	author leonardr;	state dead;
branches;
next	;


desc
@@


1.1
log
@file TaskException.java was initially added on branch HELM_PEER_PORT_BRANCH.
@
text
@@


1.1.2.1
log
@This exception is thrown when there is an error when processing a task,
often triggered by error in an external script.
@
text
@a0 87
/* ================================================================
 * Copyright (c) 2000 CollabNet.  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 CollabNet (http://www.collab.net/)."
 * Alternately, this acknowlegement may appear in the software itself, if
 * and wherever such third-party acknowlegements normally appear.
 * 
 * 4. The hosted project names must not be used to endorse or promote
 * products derived from this software without prior written
 * permission. For written permission, please contact info@@collab.net.
 * 
 * 5. Products derived from this software may not use the "Tigris" name
 * nor may "Tigris" appear in their names without prior written
 * permission of Collab.Net.
 * 
 * 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 COLLABNET 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 CollabNet.
 */


package org.tigris.helm.tool;

import java.io.InputStream;

import org.apache.turbine.util.TurbineException;

/**
 * This exception is thrown when there is an error when processing a task,
 * often triggered by error in an external script.
 *
 * @@author <a href="mailto:dlr@@collab.net">Daniel Rall</a>
 * @@version $Id: $
 */
public class TaskException extends TurbineException
{
    public TaskException(int retval, InputStream errorStream)
    {
        super(getError(retval, errorStream));
    }
  
    public TaskException(Exception e)
    {
        super(e);
    }

    public TaskException(String msg)
    {
        super(msg);
    }

    public TaskException(String msg, Exception e)
    {
        super(msg, e);
    }

    private static String getError(int retval, InputStream errorStream)
    {
        return "Process terminated with return value " + retval;
    }
}
@


1.1.2.2
log
@Properly JavaDoc'd.
@
text
@d59 1
a59 1
 * @@version $Id: TaskException.java,v 1.1.2.1 2001/02/02 22:35:59 dlr Exp $
a62 7
    /**
     * Throws an exception with a message indicating the error code.
     *
     * @@param retVal      The return value of the task.
     * @@param errorStream TODO: Unused.  Unknown what this is for.
     * @@return            An error message.
     */
a67 5
    /**
     * Throws an exception wrapping the provided exception.
     *
     * @@param e Exception to wrap.
     */
a72 5
    /**
     * Throws an exception with the specified message.
     *
     * @@param msg The error message to use.
     */
a77 7
    /**
     * Throws an exception wrapping the provided exception, with the
     * specified message.
     *
     * @@param msg The error message to use.
     * @@param e   Exception to wrap.
     */
d83 1
a83 8
    /**
     * Returns a message indicating the error code.
     *
     * @@param retVal      The return value of the task.
     * @@param errorStream TODO: Unused.  Unknown what this is for.
     * @@return            An error message.
     */
    private static final String getError(int retVal, InputStream errorStream)
d85 1
a85 1
        return "Process terminated with return value " + retVal;
@


1.1.2.3
log
@Corrected JavaDoc wording.
@
text
@d56 1
a56 1
 * often triggered by problems in an external script.
d59 1
a59 1
 * @@version $Id: TaskException.java,v 1.1.2.2 2001/02/02 22:44:00 dlr Exp $
@


1.1.2.4
log
@As long as we're rebuilding the directory structure, we might as well sort out the tool package.
@
text
@d59 1
a59 1
 * @@version $Id: TaskException.java,v 1.1.2.3 2001/02/02 23:11:40 dlr Exp $
@


