Condition

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - java.lang.RuntimeException
    - - com.heirloomcomputing.epli.runtime.Condition

All Implemented Interfaces:

java.io.Serializable
```
public class Condition
extends java.lang.RuntimeException
```
Condition - Elastic PL/I CONDITION represented as Throwable objects. User defined OnUnits specify the handler code for Conditions.

Author:

Heirloom Computing, Inc. Note: when modifying MessagesAndCodes in this file also translate and update the internationalization properties files "condition_xx_YY.properties"

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Condition.CONDITION` CONDITION - the PL/I defined CONDITIONs
`static class`	`Condition.MessagesAndCodes` MessagesAndCodes - the Elastic PL/I CONDITION codes and their messages.

Field Summary

Fields
Modifier and Type Field and Description

static int BYTES
size in bytes if converted to a byte array hint: cannot be converted to a byte array

Fields
Modifier and Type	Field and Description
`static int`	`BYTES` size in bytes if converted to a byte array hint: cannot be converted to a byte array

Constructor Summary

Constructors
Constructor and Description
`Condition()` Construct an unknown condition or internal error
`Condition(Condition.CONDITION condition, Condition.MessagesAndCodes messageAndCode)` Construct a specific condition with a known message and code
`Condition(Condition.CONDITION condition, Condition.MessagesAndCodes messageAndCode, Condition on, java.lang.Object... otherMessages)` Construct a specific condition with a known message, other info
`Condition(Condition.CONDITION condition, Condition.MessagesAndCodes messageAndCode, int subcode1)` Construct a specific condition with a known message, code and subcode
`Condition(Condition.CONDITION condition, Condition.MessagesAndCodes messageAndCode, int subcode1, java.lang.String on)` Construct a specific condition with a known message and code
`Condition(Condition.CONDITION condition, Condition.MessagesAndCodes messageAndCode, IPLIFile on, java.lang.Object... otherMessages)` Construct a specific condition with a known message, other info
`Condition(Condition.CONDITION condition, Condition.MessagesAndCodes messageAndCode, java.lang.String on)` Construct a specific condition with a known message and code, referencing another condition
`Condition(Condition.CONDITION condition, Condition.MessagesAndCodes messageAndCode, java.lang.String on, java.lang.Object... otherMessages)` Construct a specific condition with a known message, other info
`Condition(Condition.CONDITION condition, java.lang.String... description)` Construct a specific condition with a known message, other info
`Condition(java.lang.String description)` Construct an ERROR `Condition` with a specific error message

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`Activate(OnUnit onUnit)` Activate the condition associated with the given `OnUnit`.
`java.lang.Integer`	`code()` Return the code associated with this CONDITION
`Condition.CONDITION`	`conditiion()` Return the CONDITION associated with this Condition
`java.lang.String`	`condition()` Return the CONDITION name
`static void`	`Disable(Condition.CONDITION condition)` Disable a condition within this block
`static void`	`Enable(Condition.CONDITION condition)` Enable a condition within this block
`boolean`	`equals(Condition.CONDITION otherCONDITION, java.lang.String otherOn)` Return whether two conditions equal
`boolean`	`equals(java.lang.Object other)` Return whether the contents of two conditions equal, either full Conditions or just the CONDITION type
`java.lang.String`	`getCodeAndMessage()` Return the String representation of the `MessageAndCode` associated with this Condition
`boolean`	`handle()` handle this Condition by invoking the Activated OnUnit that is currently in effect.
`static boolean`	`IsEnabled(Condition.CONDITION condition)` indicate whether a condition is currently enabled
`static boolean`	`IsEnabled(Condition condition)` indicate whether a condition is currently enabled
`static Condition`	`LastCondition()` Return the last Condition raised by the program
`static Condition.CONDITION`	`LastIgnoredCondition()` Return the last Condition that was checked (but perhaps not raised)
`static void`	`main(java.lang.String[] args)` unit test case for Condition
`java.lang.String`	`message()` Return the message associated with this CONDITION
`Condition`	`onCondition()` Return the user defined Condition variable for which this CONDITION was raised
`java.lang.String`	`onFile()` Return the file for which this CONDITION was raised
`java.lang.String`	`onName()` Return the named element (e.g.
`static void`	`OnSystem(Condition.CONDITION condition, IPLIFile onFile, Condition onCondition, boolean snap)` OnSystem is executed with an "ON condition SYSTEM;" statement and does not originate from `OnUnit` processing as it applies to revert a specific `OnUnit` that is associated with a condition.
`static boolean`	`Pop(Condition.CONDITION condition)` Pop the enable/disable status for a condition within this block
`static void`	`Push(Condition.CONDITION condition)` Push the enable/disable status for a condition within this block
`static int`	`RaiseCondition(Condition.CONDITION condition)` Static method that constructs and then throws a Condition if it is enabled.
`static int`	`RaiseCondition(Condition.CONDITION condition, Condition.MessagesAndCodes messageAndCode)` Static method that constructs and then throws a Condition if it is enabled.
`static int`	`RaiseCondition(Condition.CONDITION condition, Condition.MessagesAndCodes messageAndCode, Condition on, java.lang.Object... otherMessages)` Static method that constructs and then throws a Condition if it is enabled.
`static int`	`RaiseCondition(Condition.CONDITION condition, Condition.MessagesAndCodes messageAndCode, IPLIFile on, java.lang.Object... otherMessages)` Static method that constructs and then throws a Condition if it is enabled.
`static int`	`RaiseCondition(Condition.CONDITION condition, Condition.MessagesAndCodes messageAndCode, java.lang.String on, java.lang.Object... otherMessages)` Static method that constructs and then throws a Condition if it is enabled.
`static int`	`RaiseCondition(Condition.CONDITION condition, java.lang.String description)` Static method that constructs and then throws a Condition if it is enabled.
`static void`	`Reset()` reset the Condition messages file using the current default locale
`static void`	`Revert(OnUnit onUnit)` Revert the condition associated with the given `OnUnit` to the prior one defined (or default action if none were previously activated).
`static void`	`Snap(Condition.CONDITION condition)` Snap - snap a trace back
`int`	`subcode()` Return the subcode associated with this CONDITION
`java.lang.String`	`summary()` Return the summary description of this condition (without messages & codes)
`java.lang.String`	`toString()` Return a debugging string describing this Condition
`static Condition`	`valueOf(java.lang.Throwable throwable)`

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - BYTES
```
public static final int BYTES
```
    size in bytes if converted to a byte array hint: cannot be converted to a byte array
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Condition
```
public Condition()
```
    Construct an unknown condition or internal error
  - Condition
```
public Condition(Condition.CONDITION condition,
                 Condition.MessagesAndCodes messageAndCode)
```
    Construct a specific condition with a known message and code
    
    Parameters:
    
    condition - - CONDITION to throw
    
    messageAndCode - - MessageAndCode with specific message
  - Condition
```
public Condition(Condition.CONDITION condition,
                 Condition.MessagesAndCodes messageAndCode,
                 int subcode1)
```
    Construct a specific condition with a known message, code and subcode
    
    Parameters:
    
    condition - - CONDITION to throw
    
    messageAndCode - - MessageAndCode with specific message
    
    subcode1 - and a more detailed sub-code
  - Condition
```
public Condition(Condition.CONDITION condition,
                 Condition.MessagesAndCodes messageAndCode,
                 java.lang.String on)
```
    Construct a specific condition with a known message and code, referencing another condition
    
    Parameters:
    
    condition - - CONDITION to throw
    
    messageAndCode - - MessageAndCode with specific message
    
    on - - a condition name (CONDITION condition), file name (KEY, ENDFILE, UNDEFINEDFILE)
  - Condition
```
public Condition(Condition.CONDITION condition,
                 Condition.MessagesAndCodes messageAndCode,
                 int subcode1,
                 java.lang.String on)
```
    Construct a specific condition with a known message and code
    
    Parameters:
    
    condition - - CONDITION to throw
    
    messageAndCode - - MessageAndCode with specific message
    
    subcode1 - - a more detailed sub-code
    
    on - - a condition name (CONDITION condition), file name (KEY, ENDFILE, UNDEFINEDFILE)
  - Condition
```
public Condition(Condition.CONDITION condition,
                 Condition.MessagesAndCodes messageAndCode,
                 java.lang.String on,
                 java.lang.Object... otherMessages)
```
    Construct a specific condition with a known message, other info
    
    Parameters:
    
    condition - - CONDITION to throw
    
    messageAndCode - - MessageAndCode with specific message
    
    on - - a condition name (CONDITION condition), file name (KEY, ENDFILE, UNDEFINEDFILE)
    
    otherMessages - - and a more detailed message components to insert into the MessageAndCodes template
  - Condition
```
public Condition(Condition.CONDITION condition,
                 Condition.MessagesAndCodes messageAndCode,
                 IPLIFile on,
                 java.lang.Object... otherMessages)
```
    Construct a specific condition with a known message, other info
    
    Parameters:
    
    condition - - CONDITION to throw
    
    messageAndCode - - MessageAndCode with specific message
    
    on - - a IPLIFile associated with some conditions (KEY, ENDFILE, UNDEFINEDFILE)
    
    otherMessages - - and a more detailed message components to insert into the MessageAndCodes template
  - Condition
```
public Condition(Condition.CONDITION condition,
                 Condition.MessagesAndCodes messageAndCode,
                 Condition on,
                 java.lang.Object... otherMessages)
```
    Construct a specific condition with a known message, other info
    
    Parameters:
    
    condition - - CONDITION to throw
    
    messageAndCode - - MessageAndCode with specific message
    
    on - - a user-defined Condition variable
    
    otherMessages - - and a more detailed message components to insert into the MessageAndCodes template
  - Condition
```
public Condition(java.lang.String description)
```
    Construct an ERROR Condition with a specific error message
    
    Parameters:
    
    description - - associated with an ERROR Condition
  - Condition
```
public Condition(Condition.CONDITION condition,
                 java.lang.String... description)
```
    Construct a specific condition with a known message, other info
    
    Parameters:
    
    condition - - CONDITION to throw
    
    description - - and a more detailed message components to insert into the MessageAndCodes template
- Method Detail
  - LastCondition
```
public static Condition LastCondition()
```
    Return the last Condition raised by the program
    
    Returns:
    
    Condition - the most recent condition raised or null if no condition has occurred
  - LastIgnoredCondition
```
public static Condition.CONDITION LastIgnoredCondition()
```
    Return the last Condition that was checked (but perhaps not raised)
    
    Returns:
    
    the most recent CONDITION checked via IsEnabled()
  - valueOf
```
public static Condition valueOf(java.lang.Throwable throwable)
```
  - RaiseCondition
```
public static int RaiseCondition(Condition.CONDITION condition,
                                 Condition.MessagesAndCodes messageAndCode,
                                 java.lang.String on,
                                 java.lang.Object... otherMessages)
```
    Static method that constructs and then throws a Condition if it is enabled. Used in expressions such as "byte b = (i>127)?RaiseCondition(Condition.CONDITION.OVERFLOW):(byte)i"
    
    Parameters:
    
    condition - - CONDITION to throw
    
    messageAndCode - - MessageAndCode with specific message
    
    on - - a condition name (CONDITION condition), file name (KEY, ENDFILE, UNDEFINEDFILE)
    
    otherMessages - - and a more detailed message components to insert into the MessageAndCodes template
    
    Returns:
    
    - 0 if the condition is not enabled, 1 if enabled and handled by an OnUnit
    
    Throws:
    
    Condition - if enabled but not handled
  - RaiseCondition
```
public static int RaiseCondition(Condition.CONDITION condition,
                                 Condition.MessagesAndCodes messageAndCode,
                                 Condition on,
                                 java.lang.Object... otherMessages)
```
    Static method that constructs and then throws a Condition if it is enabled. Used in expressions such as "byte b = (i>127)?RaiseCondition(Condition.CONDITION.OVERFLOW):(byte)i"
    
    Parameters:
    
    condition - - CONDITION to throw
    
    messageAndCode - - MessageAndCode with specific message
    
    on - - a user-defined Condition (CONDITION condition)
    
    otherMessages - - and a more detailed message components to insert into the MessageAndCodes template
    
    Returns:
    
    - 0 if the condition is not enabled, 1 if enabled and handled by an OnUnit
    
    Throws:
    
    Condition - if enabled but not handled
  - RaiseCondition
```
public static int RaiseCondition(Condition.CONDITION condition,
                                 Condition.MessagesAndCodes messageAndCode,
                                 IPLIFile on,
                                 java.lang.Object... otherMessages)
```
    Static method that constructs and then throws a Condition if it is enabled. Used in expressions such as "byte b = (i>127)?RaiseCondition(Condition.CONDITION.OVERFLOW):(byte)i"
    
    Parameters:
    
    condition - - CONDITION to throw
    
    messageAndCode - - MessageAndCode with specific message
    
    on - - a IPLIFile associated with some conditions (KEY, ENDFILE, UNDEFINEDFILE)
    
    otherMessages - - and a more detailed message components to insert into the MessageAndCodes template
    
    Returns:
    
    - 0 if the condition is not enabled, 1 if enabled and handled by an OnUnit
    
    Throws:
    
    Condition - if enabled but not handled
  - RaiseCondition
```
public static int RaiseCondition(Condition.CONDITION condition,
                                 Condition.MessagesAndCodes messageAndCode)
```
    Static method that constructs and then throws a Condition if it is enabled. Used in expressions such as "byte b = (i>127)?RaiseCondition(Condition.CONDITION.OVERFLOW):(byte)i"
    
    Parameters:
    
    condition - - CONDITION to throw
    
    messageAndCode - - MessageAndCode with specific message
    
    Returns:
    
    - 0 if the condition is not enabled, 1 if enabled and handled by an OnUnit
    
    Throws:
    
    Condition - if enabled but not handled
  - RaiseCondition
```
public static int RaiseCondition(Condition.CONDITION condition)
```
    Static method that constructs and then throws a Condition if it is enabled. Used in expressions such as "byte b = (i>127)?RaiseCondition(Condition.CONDITION.OVERFLOW):(byte)i"
    
    Parameters:
    
    condition - - CONDITION to throw
    
    Returns:
    
    - 0 if the condition is not enabled, 1 if enabled and handled by an OnUnit
    
    Throws:
    
    Condition - if enabled but not handled
  - RaiseCondition
```
public static int RaiseCondition(Condition.CONDITION condition,
                                 java.lang.String description)
```
    Static method that constructs and then throws a Condition if it is enabled. Used in expressions such as "byte b = (i>127)?RaiseCondition(Condition.CONDITION.OVERFLOW):(byte)i"
    
    Parameters:
    
    condition - - CONDITION to throw
    
    description - - general description
    
    Returns:
    
    - 0 if the condition is not enabled, 1 if enabled and handled by an OnUnit
    
    Throws:
    
    Condition - if enabled but not handled
  - conditiion
```
public Condition.CONDITION conditiion()
```
    Return the CONDITION associated with this Condition
    
    Returns:
    
    a CONDITION enum value
  - code
```
public java.lang.Integer code()
```
    Return the code associated with this CONDITION
    
    Returns:
    
    integer code
  - subcode
```
public int subcode()
```
    Return the subcode associated with this CONDITION
    
    Returns:
    
    integer subcode
  - message
```
public java.lang.String message()
```
    Return the message associated with this CONDITION
    
    Returns:
    
    String message
  - onName
```
public java.lang.String onName()
```
    Return the named element (e.g. FILE) on which this CONDITION was raised
    
    Returns:
    
    String ON element
  - onFile
```
public java.lang.String onFile()
```
    Return the file for which this CONDITION was raised
    
    Returns:
    
    IPLIFile ON file name or user-defined Condition name or null if this CONDITION is not for files
  - onCondition
```
public Condition onCondition()
```
    Return the user defined Condition variable for which this CONDITION was raised
    
    Returns:
    
    Condition ON variable or null if this CONDITION is not for user-defined conditions
  - condition
```
public java.lang.String condition()
```
    Return the CONDITION name
    
    Returns:
    
    String CONDITION name
  - summary
```
public java.lang.String summary()
```
    Return the summary description of this condition (without messages & codes)
    
    Returns:
    
    String CONDITION summary
  - equals
```
public boolean equals(java.lang.Object other)
```
    Return whether the contents of two conditions equal, either full Conditions or just the CONDITION type
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    other - - the other Condition or Condition.CONDITION
    
    Returns:
    
    true if the condition name and its arguments are the same
  - equals
```
public boolean equals(Condition.CONDITION otherCONDITION,
                      java.lang.String otherOn)
```
    Return whether two conditions equal
    
    Parameters:
    
    otherCONDITION - - the other Condition
    
    otherOn - - the other Condition's "ON" attribute
    
    Returns:
    
    true if the condition name and its arguments are the same (incl null)
  - getCodeAndMessage
```
public java.lang.String getCodeAndMessage()
```
    Return the String representation of the MessageAndCode associated with this Condition
    
    Returns:
    
    a String of the message and its code
  - toString
```
public java.lang.String toString()
```
    Return a debugging string describing this Condition
    
    Overrides:
    
    toString in class java.lang.Throwable
    
    Returns:
    
    a debugging string
  - IsEnabled
```
public static boolean IsEnabled(Condition.CONDITION condition)
```
    indicate whether a condition is currently enabled
    
    Parameters:
    
    condition - - the simple Condition.CONDITION to check, irrespective of any ON file or variable
    
    Returns:
    
    true if the condition is currently enabled
  - IsEnabled
```
public static boolean IsEnabled(Condition condition)
```
    indicate whether a condition is currently enabled
    
    Parameters:
    
    condition - - the full Condition to check, including the ON file or condition variable
    
    Returns:
    
    true if the condition is currently enabled
  - handle
```
public boolean handle()
```
    handle this Condition by invoking the Activated OnUnit that is currently in effect.
    
    Returns:
    
    true if an OnUnit's handler for this Condition was invoked, false if no OnUnit is in scope to handle this condition.
  - Activate
```
public static void Activate(OnUnit onUnit)
```
    Activate the condition associated with the given OnUnit.
    
    Parameters:
    
    onUnit - - the OnUnit defining the Condition to activate and the handler that should be invoked should RaiseCondition occur on it
  - Revert
```
public static void Revert(OnUnit onUnit)
```
    Revert the condition associated with the given OnUnit to the prior one defined (or default action if none were previously activated).
    
    Parameters:
    
    onUnit - - the OnUnit defining the Condition to revert and the handler that should be invoked should RaiseCondition occur on it
  - OnSystem
```
public static void OnSystem(Condition.CONDITION condition,
                            IPLIFile onFile,
                            Condition onCondition,
                            boolean snap)
```
    OnSystem is executed with an "ON condition SYSTEM;" statement and does not originate from OnUnit processing as it applies to revert a specific OnUnit that is associated with a condition.
    
    Parameters:
    
    condition - - the Condition.CONDITION on which the "ON condition SYSTEM;" is being invoked
    
    onFile - - the IPLIFile variable associated with the condition, if it is that type (optional)
    
    onCondition - - the Condition variable associated with the condition, if it is that type (optional)
    
    snap - - boolean indicating that SNAP was specified on the ON statement
  - Snap
```
public static void Snap(Condition.CONDITION condition)
```
    Snap - snap a trace back
    
    Parameters:
    
    condition - - the condition to enable
  - Enable
```
public static void Enable(Condition.CONDITION condition)
```
    Enable a condition within this block
    
    Parameters:
    
    condition - - the condition to enable
  - Disable
```
public static void Disable(Condition.CONDITION condition)
```
    Disable a condition within this block
    
    Parameters:
    
    condition - - the condition to disable
  - Push
```
public static void Push(Condition.CONDITION condition)
```
    Push the enable/disable status for a condition within this block
    
    Parameters:
    
    condition - - the condition to push (retains the same state as the prior value which is ENABLED by default)
  - Pop
```
public static boolean Pop(Condition.CONDITION condition)
```
    Pop the enable/disable status for a condition within this block
    
    Parameters:
    
    condition - - the condition to push (retains the same state as the prior value which is ENABLED by default)
    
    Returns:
    
    the current enabled state of this condition after popping
  - Reset
```
public static void Reset()
```
    reset the Condition messages file using the current default locale
  - main
```
public static void main(java.lang.String[] args)
```
    unit test case for Condition

Class Condition

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Field Detail

BYTES

Constructor Detail

Condition

Condition

Condition

Condition

Condition

Condition

Condition

Condition

Condition

Condition

Method Detail

LastCondition

LastIgnoredCondition

valueOf

RaiseCondition

RaiseCondition

RaiseCondition

RaiseCondition

RaiseCondition

RaiseCondition

conditiion

code

subcode

message

onName

onFile

onCondition

condition

summary

equals

equals

getCodeAndMessage

toString

IsEnabled

IsEnabled

handle

Activate

Revert

OnSystem

Snap

Enable

Disable

Push

Pop

Reset

main