com.heirloomcomputing.epli.runtime

Class OnUnit

java.lang.Object

com.heirloomcomputing.epli.runtime.OnUnit

public abstract class OnUnit
extends java.lang.Object

Elastic PL/I abstract class that supports PL/I "ON units", providing handlers for raised Conditions

Author:

Heirloom Computing, Inc.

Constructor Summary

Constructors

Constructor and Description
OnUnit(Condition.CONDITION theCONDITION, Condition theCondition, java.lang.String... info) constructor - define but do not activate this OnUnit with certain identifying info at the point of the ON statement.
OnUnit(Condition.CONDITION theCONDITION, IPLIFile theFile, java.lang.String... info) constructor - define but do not activate this OnUnit with certain identifying info at the point of the ON statement.
OnUnit(Condition.CONDITION theCONDITION, java.lang.String... info) constructor - define but do not activate this OnUnit with certain identifying info at the point of the ON statement.

Method Summary

Modifier and Type	Method and Description
Condition.CONDITION	getCondition() getter for the Condition for which this OnUnit applies.
IPLIFile	getFile() getter for the subject file to which this OnUnit applies.
java.lang.String[]	getInfo() getter for the optional information retained about this condition or on-unit
boolean	getSnap() getter for the snap indicator.
Condition	getUserCondition() getter for the user defined Condition variable to which this OnUnit applies.
abstract void	handler(Condition _condition) handler - must define a handler for this ON unit which is the code defined within an ON statement for handling the condition.
OnUnit	onStatement(boolean snap) onStatement - activate an OnUnit with an ON statement.
OnUnit	resignalStatement() resignalStatement - raise the condition associated with this ON unit thus invoking the handler defined for it, as with a RESIGNAL statement Do not override.
OnUnit	revertStatement() revertStatement - when an ON unit block falls out of scope or with an explicit REVERT statement, revert to the previous action for this OnUnit.
OnUnit	signalStatement() signalStatement - raise the condition associated with this ON unit thus invoking the handler defined for it, as with a SIGNAL statement Do not override.
java.lang.String	toString() return information about this on unit

Methods inherited from class java.lang.Object

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

Constructor Detail

OnUnit

public OnUnit(Condition.CONDITION theCONDITION,
              java.lang.String... info)

constructor - define but do not activate this OnUnit with certain identifying info at the point of the ON statement. used for OnUnits with a condition only. The class which extends OnUnit must implement a constructor that invokes super theCONDITION, theProcedure, theBlockDepth); as its first action.

Parameters:

theCONDITION - - the CONDITION to which this OnUnit applies

info - - String[] info about the OnUnit (optional)

OnUnit

public OnUnit(Condition.CONDITION theCONDITION,
              IPLIFile theFile,
              java.lang.String... info)

constructor - define but do not activate this OnUnit with certain identifying info at the point of the ON statement. used for OnUnits with a condition and a subject. The class which extends OnUnit must implement a constructor that invokes super theCONDITION, theSubject, theProcedure, theBlockDepth); as its first action.

Parameters:

theCONDITION - - the CONDITION to which this OnUnit applies

theFile - - the subject of the ON statement for those that have them (e.g., "ON ENDFILE(MYFILE) BEGIN;...END;")

info - - String[] info about the OnUnit (optional)

OnUnit

public OnUnit(Condition.CONDITION theCONDITION,
              Condition theCondition,
              java.lang.String... info)

constructor - define but do not activate this OnUnit with certain identifying info at the point of the ON statement. Used for OnUnits with a condition and a subject. The class which extends OnUnit must implement a constructor that invokes super theCONDITION, theCondition, theProcedure, theBlockDepth); as its first action.

Parameters:

theCONDITION - - the CONDITION to which this OnUnit applies

theCondition - - the user defined Condition variable of the ON statement for those that have them (e.g., "ON CONDITION(MYCONDVAR) BEGIN;...END;")

info - - String[] info about the OnUnit (optional)

Method Detail

handler

public abstract void handler(Condition _condition)

handler - must define a handler for this ON unit which is the code defined within an ON statement for handling the condition. Must be overridden by the class that extends OnUnit generated within user code.

Parameters:

_condition - - the Condition to be handled

onStatement

public final OnUnit onStatement(boolean snap)

onStatement - activate an OnUnit with an ON statement.

Parameters:

snap - - boolean indicating SNAP keyword was specified Do not override.

Returns:

this to facilitate chaining.

revertStatement

public final OnUnit revertStatement()

revertStatement - when an ON unit block falls out of scope or with an explicit REVERT statement, revert to the previous action for this OnUnit. Do not override.

Returns:

this to facilitate chaining.

signalStatement

public final OnUnit signalStatement()

signalStatement - raise the condition associated with this ON unit thus invoking the handler defined for it, as with a SIGNAL statement Do not override.

Returns:

this to facilitate chaining.

resignalStatement

public final OnUnit resignalStatement()

resignalStatement - raise the condition associated with this ON unit thus invoking the handler defined for it, as with a RESIGNAL statement Do not override.

Returns:

this to facilitate chaining.

getCondition

public Condition.CONDITION getCondition()

getter for the Condition for which this OnUnit applies.

Returns:

CONDITION for which this OnUnit was defined.

getFile

public IPLIFile getFile()

getter for the subject file to which this OnUnit applies.

Returns:

IPLIFile of the subject of this OnUnit or null if this OnUnit does not apply to a condition specified with a file

getInfo

public java.lang.String[] getInfo()

getter for the optional information retained about this condition or on-unit

Returns:

IPLIFile of the subject of this OnUnit or null if this OnUnit does not apply to a condition specified with a file

getUserCondition

public Condition getUserCondition()

getter for the user defined Condition variable to which this OnUnit applies.

Returns:

Condition defined for this OnUnit for user-defined Condition variables or null if this does not apply to a user-defined Condition

getSnap

public boolean getSnap()

getter for the snap indicator.

Returns:

true if SNAP was specified when the OnUnit was invoked

toString

public java.lang.String toString()

return information about this on unit

Overrides:

toString in class java.lang.Object

Returns:

String containing information about this ON unit