org.unix4j.command

Class ExitValueException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.unix4j.command.ExitValueException

All Implemented Interfaces:

Serializable

public class ExitValueException
extends RuntimeException

An exception thrown when a command terminates with an error; in Unix, the command would return a value different from zero. Note that the Java VM does NOT terminate and exit if such an exception occurs.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExitValueException(String message, int exitValue) Constructor with message and non-zero exit value.
ExitValueException(String message, int exitValue, Throwable cause) Constructor with message, a non-zero exit value and a causing exception.

Method Summary

Modifier and Type	Method and Description
int	getExitValue() Returns the exit value, an int value or error code different from zero that was passed to the constructor of this exception.
Input	getInput() Returns the input source that was causing this exception, for instance an input file that was passed to a command.
String	getMessage()
void	setInput(Input input) Sets the input source that was causing this exception, for instance an input file that was passed to a command.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExitValueException

public ExitValueException(String message,
                          int exitValue)

Constructor with message and non-zero exit value.

Parameters:

message - the error message

exitValue - the exit value, must be different from zero

Throws:

IllegalArgumentException - if exitValue==0

ExitValueException

public ExitValueException(String message,
                          int exitValue,
                          Throwable cause)

Constructor with message, a non-zero exit value and a causing exception.

Parameters:

message - the error message

exitValue - the exit value, must be different from zero

cause - the exception that caused the error termination of the command

Throws:

IllegalArgumentException - if exitValue==0

Method Detail

getExitValue

public int getExitValue()

Returns the exit value, an int value or error code different from zero that was passed to the constructor of this exception.

Returns:

the non-zero exit or error code value

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

setInput

public void setInput(Input input)

Sets the input source that was causing this exception, for instance an input file that was passed to a command.

Parameters:

input - the input source or file that was causing the exception

getInput

public Input getInput()

Returns the input source that was causing this exception, for instance an input file that was passed to a command. Returns null if it is unknown.

Returns:

the input source or file that was causing the exception, or null if it is not known