Condition.CONDITION

java.lang.Object
- java.lang.Enum<Condition.CONDITION>
- - com.heirloomcomputing.epli.runtime.Condition.CONDITION

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Condition.CONDITION>

Enclosing class:

Condition
```
public static enum Condition.CONDITION
extends java.lang.Enum<Condition.CONDITION>
```
CONDITION - the PL/I defined CONDITIONs

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ANYCONDITION` ANYCONDITION can be used only in ON (and REVERT) statements to establish (and cancel) an ON-unit that will trap any condition, including the CONDITION condition, that occurs in a block, and that is not trapped by some other eligible ON-unit in that block.
`AREA` AREA is raised: (1) When an attempt is made to allocate a based variable within an area that contains insufficient free storage for the allocation to be made; (2) When an attempt is made to perform an area assignment and the target area contains insufficient storage to accommodate the allocations in the source area.
`ATTENTION` The ATTENTION condition is raised when the user hits a specific key combination to interrupt an application.
`CONDITION` The CONDITION condition is raised by a SIGNAL statement.
`CONVERSION` The CONVERSION computational condition is raised whenever an invalid conversion is attempted on character, widechar, or graphic data.
`ENDFILE` The ENDFILE input/output condition can be raised during an operation by an attempt to read past the end of the file specified in the GET or READ statement.
`ENDPAGE` When ENDPAGE is raised, the current line number is one greater than that specified by the PAGESIZE option (default is 60) so that it is possible to continue writing on the same page.
`ERROR` The ERROR condition is the implicit action for many conditions.
`FINISH` The FINISH condition is raised during execution of a statement that would terminate the procedures.
`FIXEDOVERFLOW` The FIXEDOVERFLOW computational condition is raised when the length of the result of a FIXED DECIMAL arithmetic operation exceeds the maximum length allowed by the implementation.
`INVALIDOP` The INVALIDOP computational condition is raised when any of the following are detected during the evaluation of IEEE floating-point expressions.
`KEY` The KEY input/output condition is raised when a record with a specified key cannot be found.
`NAME` The NAME input/output condition can be raised only during execution of a data-directed GET statement with the FILE option.
`OVERFLOW` The OVERFLOW computational condition is raised when the magnitude of a floating-point number exceeds the maximum allowed.
`RECORD` The RECORD input/output condition is raised if the specified record is truncated.
`SIZE` The SIZE computational condition is raised only when high-order (that is, leftmost) significant binary or decimal digits are lost in an attempted assignment to a variable or an intermediate result or in an input/output operation.
`SQLEXCEPTION` EPLI Extension: SQLEXCEPTION is raised when a SQL WHENEVER would be triggered.
`STORAGE` The STORAGE condition allows the program to gain control for the failure of an ALLOCATE built-in function or ALLOCATE statement that attempted to allocate BASED or CONTROLLED storage outside of an AREA.
`STRINGRANGE` The STRINGRANGE program-checkout condition is raised whenever the values of the arguments to a SUBSTR reference fail to comply with the rules described for the SUBSTR built-in function.
`STRINGSIZE` The STRINGSIZE program-checkout condition is raised when you attempt to assign a string to a target with a shorter maximum length.
`SUBSCRIPTRANGE` The SUBSCRIPTRANGE program-checkout condition is raised whenever a subscript is evaluated and found to lie outside its specified bounds.
`TRANSMIT` The TRANSMIT input/output condition is raised by an uncorrectable transmission error of a record (or of a block, if records are blocked), which is an input/output error that could not be corrected during execution.
`UNDEFINEDFILE` The UNDEFINEDFILE input/output condition is raised whenever an unsuccessful attempt to open a file is made.
`UNDERFLOW` The UNDERFLOW computational condition is raised when the magnitude of a floating-point number is smaller than the minimum allowed.
`USERDEFINED` A USERDEFINED condition is raised for the corresponding Condition variable.
`ZERODIVIDE` The ZERODIVIDE computational condition is raised when an attempt is made to divide by zero.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`summary()` Return the summary of this CONDITION
`static Condition.CONDITION`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static Condition.CONDITION[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - ANYCONDITION
```
public static final Condition.CONDITION ANYCONDITION
```
    ANYCONDITION can be used only in ON (and REVERT) statements to establish (and cancel) an ON-unit that will trap any condition, including the CONDITION condition, that occurs in a block, and that is not trapped by some other eligible ON-unit in that block. ordinal 0.
  - AREA
```
public static final Condition.CONDITION AREA
```
    AREA is raised: (1) When an attempt is made to allocate a based variable within an area that contains insufficient free storage for the allocation to be made; (2) When an attempt is made to perform an area assignment and the target area contains insufficient storage to accommodate the allocations in the source area. ordinal 1.
  - ATTENTION
```
public static final Condition.CONDITION ATTENTION
```
    The ATTENTION condition is raised when the user hits a specific key combination to interrupt an application. ordinal 2.
  - CONDITION
```
public static final Condition.CONDITION CONDITION
```
    The CONDITION condition is raised by a SIGNAL statement. The name specified in the SIGNAL statement determines which Condition is raised. Just Dropped In To See What Condition My Condition Was In. ordinal 3.
  - CONVERSION
```
public static final Condition.CONDITION CONVERSION
```
    The CONVERSION computational condition is raised whenever an invalid conversion is attempted on character, widechar, or graphic data. ordinal 4.
  - ENDFILE
```
public static final Condition.CONDITION ENDFILE
```
    The ENDFILE input/output condition can be raised during an operation by an attempt to read past the end of the file specified in the GET or READ statement. ordinal 5.
  - ENDPAGE
```
public static final Condition.CONDITION ENDPAGE
```
    When ENDPAGE is raised, the current line number is one greater than that specified by the PAGESIZE option (default is 60) so that it is possible to continue writing on the same page. ordinal 6.
  - ERROR
```
public static final Condition.CONDITION ERROR
```
    The ERROR condition is the implicit action for many conditions. This provides a common condition that can be used to check for a number of different conditions, rather than checking each condition separately. ordinal 7.
  - FINISH
```
public static final Condition.CONDITION FINISH
```
    The FINISH condition is raised during execution of a statement that would terminate the procedures. ordinal 8.
  - FIXEDOVERFLOW
```
public static final Condition.CONDITION FIXEDOVERFLOW
```
    The FIXEDOVERFLOW computational condition is raised when the length of the result of a FIXED DECIMAL arithmetic operation exceeds the maximum length allowed by the implementation. ordinal 9.
  - INVALIDOP
```
public static final Condition.CONDITION INVALIDOP
```
    The INVALIDOP computational condition is raised when any of the following are detected during the evaluation of IEEE floating-point expressions. ordinal 10.
  - KEY
```
public static final Condition.CONDITION KEY
```
    The KEY input/output condition is raised when a record with a specified key cannot be found. ordinal 11.
  - NAME
```
public static final Condition.CONDITION NAME
```
    The NAME input/output condition can be raised only during execution of a data-directed GET statement with the FILE option. ordinal 12.
  - OVERFLOW
```
public static final Condition.CONDITION OVERFLOW
```
    The OVERFLOW computational condition is raised when the magnitude of a floating-point number exceeds the maximum allowed. ordinal 13.
  - RECORD
```
public static final Condition.CONDITION RECORD
```
    The RECORD input/output condition is raised if the specified record is truncated. ordinal 14.
  - SIZE
```
public static final Condition.CONDITION SIZE
```
    The SIZE computational condition is raised only when high-order (that is, leftmost) significant binary or decimal digits are lost in an attempted assignment to a variable or an intermediate result or in an input/output operation. ordinal 15.
  - SQLEXCEPTION
```
public static final Condition.CONDITION SQLEXCEPTION
```
    EPLI Extension: SQLEXCEPTION is raised when a SQL WHENEVER would be triggered. ordinal 16.
  - STORAGE
```
public static final Condition.CONDITION STORAGE
```
    The STORAGE condition allows the program to gain control for the failure of an ALLOCATE built-in function or ALLOCATE statement that attempted to allocate BASED or CONTROLLED storage outside of an AREA. ordinal 17.
  - STRINGRANGE
```
public static final Condition.CONDITION STRINGRANGE
```
    The STRINGRANGE program-checkout condition is raised whenever the values of the arguments to a SUBSTR reference fail to comply with the rules described for the SUBSTR built-in function. ordinal 18.
  - STRINGSIZE
```
public static final Condition.CONDITION STRINGSIZE
```
    The STRINGSIZE program-checkout condition is raised when you attempt to assign a string to a target with a shorter maximum length. ordinal 19.
  - SUBSCRIPTRANGE
```
public static final Condition.CONDITION SUBSCRIPTRANGE
```
    The SUBSCRIPTRANGE program-checkout condition is raised whenever a subscript is evaluated and found to lie outside its specified bounds. ordinal 20.
  - TRANSMIT
```
public static final Condition.CONDITION TRANSMIT
```
    The TRANSMIT input/output condition is raised by an uncorrectable transmission error of a record (or of a block, if records are blocked), which is an input/output error that could not be corrected during execution. ordinal 21.
  - UNDEFINEDFILE
```
public static final Condition.CONDITION UNDEFINEDFILE
```
    The UNDEFINEDFILE input/output condition is raised whenever an unsuccessful attempt to open a file is made. If the attempt is made by means of an OPEN statement that specifies more than one file, the condition is raised after attempts to open all specified files. ordinal 22.
  - UNDERFLOW
```
public static final Condition.CONDITION UNDERFLOW
```
    The UNDERFLOW computational condition is raised when the magnitude of a floating-point number is smaller than the minimum allowed. ordinal 23.
  - USERDEFINED
```
public static final Condition.CONDITION USERDEFINED
```
    A USERDEFINED condition is raised for the corresponding Condition variable. ordinal 24.
  - ZERODIVIDE
```
public static final Condition.CONDITION ZERODIVIDE
```
    The ZERODIVIDE computational condition is raised when an attempt is made to divide by zero. ordinal 25.
- Method Detail
  - values
```
public static Condition.CONDITION[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Condition.CONDITION c : Condition.CONDITION.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Condition.CONDITION valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - summary
```
public java.lang.String summary()
```
    Return the summary of this CONDITION
    
    Returns:
    
    the CONDITION summary

Enum Condition.CONDITION

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ANYCONDITION

AREA

ATTENTION

CONDITION

CONVERSION

ENDFILE

ENDPAGE

ERROR

FINISH

FIXEDOVERFLOW

INVALIDOP

KEY

NAME

OVERFLOW

RECORD

SIZE

SQLEXCEPTION

STORAGE

STRINGRANGE

STRINGSIZE

SUBSCRIPTRANGE

TRANSMIT

UNDEFINEDFILE

UNDERFLOW

USERDEFINED

ZERODIVIDE

Method Detail

values

valueOf

summary