com.goldencode.p2j.util

Class ErrorConditionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.goldencode.p2j.util.ConditionException

com.goldencode.p2j.util.ErrorConditionException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DeferredLegacyErrorException, LegacyErrorException

public class ErrorConditionException
extends ConditionException

Represents a Progress ERROR condition.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	end_error true if the cause of this error was the END-ERROR key.
private boolean	force true if the silent error mode should NOT be honored.
private int	progressErrorCode Error code used in Progress 4GL.

Constructor Summary

Constructors

Constructor and Description
ErrorConditionException(int progressErrorCode, java.lang.String message) Constructor which accepts an error message and an error code.
ErrorConditionException(int progressErrorCode, java.lang.String message, NumberedException cause) Constructor which accepts an error message, error code and root cause.
ErrorConditionException(java.lang.String message) Constructor which accepts an error message.
ErrorConditionException(java.lang.String message, boolean end_error) Constructor which accepts an error message.
ErrorConditionException(java.lang.String message, int keycode) Constructor which accepts an error message and the key code for the key press that caused this condition.
ErrorConditionException(java.lang.String message, int keycode, boolean end_error) Constructor which accepts an error message and the key code for the key press that caused this condition.
ErrorConditionException(java.lang.String message, java.lang.Throwable rootCause) Constructor which accepts an error message and a root cause.
ErrorConditionException(java.lang.Throwable rootCause) Constructor which accepts and wrappers a root cause.

Method Summary

Modifier and Type	Method and Description
int	getProgressErrorCode() Returns the code (which is used in Progress 4GL) of the error that was the cause of this condition.
boolean	isEndError() Detects if the cause of this condition was the END-ERROR key.
boolean	isForce() Determines if this error condition should honor silent error mode.
void	setEndError(boolean end_error) Sets the END-ERROR flag for the cause of this condition.
ErrorConditionException	setForce(boolean force) Modify the force mode flag.

Methods inherited from class com.goldencode.p2j.util.ConditionException

fillInStackTrace, getKeyCode

Methods inherited from class java.lang.Throwable

addSuppressed, getCause, getLocalizedMessage, getMessage, 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

Field Detail

end_error

private boolean end_error

true if the cause of this error was the END-ERROR key.

progressErrorCode

private int progressErrorCode

Error code used in Progress 4GL.

force

private boolean force

true if the silent error mode should NOT be honored.

Constructor Detail

ErrorConditionException

public ErrorConditionException(java.lang.String message)

Constructor which accepts an error message.

Parameters:

message - Error message.

ErrorConditionException

public ErrorConditionException(int progressErrorCode,
                               java.lang.String message)

Constructor which accepts an error message and an error code.

Parameters:

progressErrorCode - Error code (which is used in Progress 4GL).

message - Error message.

ErrorConditionException

public ErrorConditionException(int progressErrorCode,
                               java.lang.String message,
                               NumberedException cause)

Constructor which accepts an error message, error code and root cause.

Parameters:

progressErrorCode - Error code (which is used in Progress 4GL).

message - Error message.

cause - A numbered exception identifying the raised condition.

ErrorConditionException

public ErrorConditionException(java.lang.String message,
                               int keycode)

Constructor which accepts an error message and the key code for the key press that caused this condition.

Parameters:

message - Error message.

keycode - The key code of the key that caused this condition to be raised.

ErrorConditionException

public ErrorConditionException(java.lang.String message,
                               java.lang.Throwable rootCause)

Constructor which accepts an error message and a root cause. This variant is used when the error condition is detected as the result of catching another exception.

Parameters:

message - Error message.

rootCause - Exception which has been caught in the course of processing.

ErrorConditionException

public ErrorConditionException(java.lang.Throwable rootCause)

Constructor which accepts and wrappers a root cause. This variant is used when the error condition is detected as the result of catching another exception, and the message or context of the root cause is sufficient to describe the problem.

Parameters:

rootCause - Exception which has been caught in the course of processing.

ErrorConditionException

public ErrorConditionException(java.lang.String message,
                               boolean end_error)

Constructor which accepts an error message.

Parameters:

message - Error message.

end_error - true if the cause of this condition was the END-ERROR key.

ErrorConditionException

public ErrorConditionException(java.lang.String message,
                               int keycode,
                               boolean end_error)

Constructor which accepts an error message and the key code for the key press that caused this condition.

Parameters:

message - Error message.

keycode - The key code of the key that caused this condition to be raised.

end_error - true if the cause of this condition was the END-ERROR key.

Method Detail

isEndError

public boolean isEndError()

Detects if the cause of this condition was the END-ERROR key.

Returns:

true if the cause of this condition was the END-ERROR key.

setEndError

public void setEndError(boolean end_error)

Sets the END-ERROR flag for the cause of this condition.

Parameters:

end_error - true if the cause of this condition was the END-ERROR key.

getProgressErrorCode

public int getProgressErrorCode()

Returns the code (which is used in Progress 4GL) of the error that was the cause of this condition.

Returns:

The code of the error that caused this condition or -1 if it wasn't specified.

isForce

public boolean isForce()

Determines if this error condition should honor silent error mode.

Returns:

true if silent error mode should NOT be honored.

setForce

public ErrorConditionException setForce(boolean force)

Modify the force mode flag.

Parameters:

force - true to enable force mode, otherwise false.

Returns:

this will be returned to enable chaining.