com.goldencode.p2j.util

Class LegacyErrorException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.goldencode.p2j.util.ConditionException

com.goldencode.p2j.util.ErrorConditionException

com.goldencode.p2j.util.LegacyErrorException

All Implemented Interfaces:

java.io.Serializable

public class LegacyErrorException
extends ErrorConditionException

An ERROR condition which acts like a throw OO error in 4GL.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private ObjectVar<? extends LegacyError>	error The thrown LegacyError.
private LegacyError	errorRef The explicit legacy object being thrown.
private boolean	explicit Flag indicating this is an explicit thrown exception, by the application code.
private boolean	fromReturn Flag indicating if this was from a RETURN ERROR statement.

Constructor Summary

Constructors

Constructor and Description
LegacyErrorException(object<? extends LegacyError> error) Create a new instance and populate error stack trace.
LegacyErrorException(object<? extends LegacyError> error, boolean fromReturn) Create a new instance and populate error stack trace.
LegacyErrorException(object<? extends LegacyError> error, boolean fromReturn, boolean populateStack) Create a new instance.

Method Summary

Modifier and Type	Method and Description
void	clearError(boolean clearRef) Clear the errorRef and error, as they can't be serialized to the remote side.
LegacyErrorException	duplicate() Duplicate this legacy OO error.
ObjectVar<? extends LegacyError>	getError() Get the error.
LegacyError	getErrorRef() Get the getErrorRef().
(package private) boolean	isExplicit() Check the explicit flag.
(package private) boolean	isFromReturn() Check the state of the fromReturn flag.
(package private) void	setExplicit(boolean explicit) Set the explicit flag.
(package private) void	setFromReturn(boolean fromReturn) Set the fromReturn flag state.

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

getProgressErrorCode, isEndError, isForce, setEndError, setForce

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

error

private transient ObjectVar<? extends LegacyError> error

The thrown LegacyError. Used to hold a reference, so that the object will not be deleted until this exception is caught.

Do not serialize this field.

errorRef

private LegacyError errorRef

The explicit legacy object being thrown. Will be non-null only for serializable instances.

fromReturn

private boolean fromReturn

Flag indicating if this was from a RETURN ERROR statement.

explicit

private boolean explicit

Flag indicating this is an explicit thrown exception, by the application code.

Constructor Detail

LegacyErrorException

public LegacyErrorException(object<? extends LegacyError> error)

Create a new instance and populate error stack trace.

Parameters:

error - The referenced error.

LegacyErrorException

public LegacyErrorException(object<? extends LegacyError> error,
                            boolean fromReturn)

Create a new instance and populate error stack trace.

Parameters:

error - The referenced error.

fromReturn - Flag indicating if this was from a RETURN ERROR statement.

LegacyErrorException

public LegacyErrorException(object<? extends LegacyError> error,
                            boolean fromReturn,
                            boolean populateStack)

Create a new instance.

Parameters:

error - The referenced error.

fromReturn - Flag indicating if this was from a RETURN ERROR statement.

populateStack - if true, then call populate error stack trace method

Method Detail

duplicate

public LegacyErrorException duplicate()

Duplicate this legacy OO error. If the errorRef is null, a new AppError instance will be created. Otherwise, the errorRef will be re-used and its callstack will be assumed as the server's stack trace.

Returns:

See above.

clearError

public void clearError(boolean clearRef)

Clear the errorRef and error, as they can't be serialized to the remote side.

Parameters:

clearRef - When true, clear the errorRef, too.

getError

public ObjectVar<? extends LegacyError> getError()

Get the error.

Returns:

See above.

getErrorRef

public LegacyError getErrorRef()

Get the getErrorRef().

Returns:

See above.

isFromReturn

boolean isFromReturn()

Check the state of the fromReturn flag.

Returns:

See above.

setFromReturn

void setFromReturn(boolean fromReturn)

Set the fromReturn flag state.

Parameters:

fromReturn - Flag indicating if this exception is from a RETURN ERROR or UNDO, THROW top-level exit.

setExplicit

void setExplicit(boolean explicit)

Set the explicit flag.

Parameters:

explicit - true if this explicitly thrown by the application, and not FWD runtime.

isExplicit

boolean isExplicit()

Check the explicit flag.

Returns:

true if this explicitly thrown by the application, and not FWD runtime.