com.heirloomcomputing.epli.runtime

Enum IPLIFile.Attr

java.lang.Object

java.lang.Enum<IPLIFile.Attr>

com.heirloomcomputing.epli.runtime.IPLIFile.Attr

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IPLIFile.Attr>

Enclosing interface:

IPLIFile

public static enum IPLIFile.Attr
extends java.lang.Enum<IPLIFile.Attr>

Keep track of a set of PL/I FILE attributes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPEND IBM Ent PL/I ENVIRONMENT attribute APPEND(Y|N) for "extend" or "open for append" mode.
BUFFERED file is defined or opened for buffered operations that may improve performance of certain read/write or get/put operations.
BUFSIZE IBM Ent PL/I ENVIRONMENT attribute BUFSIZE(n) file buffer size.
CATLG IBM Ent PL/I Prog Guide describes JCL DISP arguments allowed after DSN keyword CATLG - after close, keep the dataset
CHARSET IBM Ent PL/I ENVIRONMENT attribute CHARSET(ASIS|ASCII|EBCDIC) for file encoding character set EPLI: not implemented in environment; use DCB settings
DDNAME the file is associated with a DDNAME specified on the command line or in configuration files.
DELAY IBM Ent PL/I ENVIRONMENT attribute DELAY(0 | n) milliseconds to delay before retrying file lock EPLI: not implemented in FILE ENVIRONMENT clause; use DCB settings.
DELETE IBM Ent PL/I Prog Guide describes JCL DISP arguments allowed after DSN keyword DELETE - after close, delete the dataset
DIRECT file is defined or opened for direct or random operations such that data my be read or written in any order based on a record number.
INPUT file is defined or opened for INPUT.
KEEP IBM Ent PL/I Prog Guide describes JCL DISP arguments allowed after DSN keyword KEEP - after close, keep the dataset
KEYED file is defined or opened for direct or random operations such that data my be read or written in any order based on an index key.
LRECL IBM Ent PL/I ENVIRONMENT attribute LRECL(n) same as RECSIZE EPLI: not implemented in FILE ENVIRONMENT clause.
LRMSKIP IBM Ent PL/I ENVIRONMENT attribute LRMSKIP(n) The LRMSKIP option allows output to begin on the nth line of the first page for the first SKIP format item to be executed after a file is opened.
MOD IBM Ent PL/I Prog Guide describes JCL DISP arguments allowed after DSN keyword MOD - open the dataset for append (same as APPEND)
OLD IBM Ent PL/I Prog Guide describes JCL DISP arguments allowed after DSN keyword OLD - open the dataset for exclusive access
OUTPUT file is defined or opened for OUTPUT.
PRINT file is being written for eventual printing (printer control characters are generated).
PROMPT IBM Ent PL/I ENVIRONMENT attribute PROMPT(Y|N) The PROMPT option specifies whether colons should be visible as prompts for stream input from the terminal.
PUTPAGE IBM Ent PL/I ENVIRONMENT attribute PUTPAGE(NOCR|CR) The PUTPAGE option specifies whether the form feed character should be followed by a carriage return character.
RECCOUNT IBM Ent PL/I ENVIRONMENT attribute RECCOUNT(n) The RECCOUNT option specifies the maximum number of records that can be loaded into a relative or regional data set that is created during the PL/I file opening process.
RECORD file is defined as record-oriented for whcih PL/I READ, WRITE, REWRITE, DELETE statements may be applied.
RECSIZE IBM Ent PL/I ENVIRONMENT attribute RECSIZE(n|512) The RECSIZE option specifies the length of records in the data set.
SAMELINE IBM Ent PL/I ENVIRONMENT attribute SAMELINE(N|Y) The SAMELINE option specifies whether the system prompt occurs on the same line as the statement that prompts for input.
SEQUENTIAL file is defined or opened for sequential operations such that data may be written or read in sequential order.
SHR IBM Ent PL/I Prog Guide describes JCL DISP arguments allowed after DSN keyword SHR - open the dataset for shared access
SKIP0 IBM Ent PL/I ENVIRONMENT attribute SKIP0(N|Y) The SKIP0 option specifies where the line cursor moves when SKIP(0) statement is coded in the source program.
STREAM file is defined as a stream for which PL/I GET and PUT statements may be applied.
SYSERR the file is associated with the standard error of the program, allowing error messages to be routed separately from standard output alternative of SYSIN, SYSOUT.
SYSIN the file is associated with the standard input of the program, allowing "piping" of information into this program.
SYSOUT the file is associated with the standard output of the program, allowing "piping" of information from this to another program.
TYPE IBM Ent PL/I ENVIRONMENT attribute TYPE(LF|CRLF|TEXT|FIXED|CRLFEOF|U) The TYPE option specifies the format of records in a native file.
UNBUFFERED file is defined or opened for unbuffered operations that may reduce performance but whose effects are more likely to be reflected in the file.
UNCATLG IBM Ent PL/I Prog Guide describes JCL DISP arguments allowed after DSN keyword UNCATLG - after close, delete the dataset
UPDATE file is defined or opened for both INPUT and OUTPUT.
VARIABLE file is a variable, not a file constant, and must be assigned from a file constant before use.

Method Summary

Modifier and Type	Method and Description
static IPLIFile.Attr	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IPLIFile.Attr[]	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

VARIABLE

public static final IPLIFile.Attr VARIABLE

file is a variable, not a file constant, and must be assigned from a file constant before use.

INPUT

public static final IPLIFile.Attr INPUT

file is defined or opened for INPUT. alternative of OUTPUT, UPDATE.

OUTPUT

public static final IPLIFile.Attr OUTPUT

file is defined or opened for OUTPUT. alternative of INPUT, UPDATE.

UPDATE

public static final IPLIFile.Attr UPDATE

file is defined or opened for both INPUT and OUTPUT. alternative of INPUT, OUTPUT.

PRINT

public static final IPLIFile.Attr PRINT

file is being written for eventual printing (printer control characters are generated).

STREAM

public static final IPLIFile.Attr STREAM

file is defined as a stream for which PL/I GET and PUT statements may be applied. alternative of RECORD.

RECORD

public static final IPLIFile.Attr RECORD

file is defined as record-oriented for whcih PL/I READ, WRITE, REWRITE, DELETE statements may be applied. alternative of STREAM

SEQUENTIAL

public static final IPLIFile.Attr SEQUENTIAL

file is defined or opened for sequential operations such that data may be written or read in sequential order. alternative of DIRECT or KEYED.

DIRECT

public static final IPLIFile.Attr DIRECT

file is defined or opened for direct or random operations such that data my be read or written in any order based on a record number. alternative of SEQUENTIAL or KEYED.

BUFFERED

public static final IPLIFile.Attr BUFFERED

file is defined or opened for buffered operations that may improve performance of certain read/write or get/put operations. alternative of UNBUFFERED.

UNBUFFERED

public static final IPLIFile.Attr UNBUFFERED

file is defined or opened for unbuffered operations that may reduce performance but whose effects are more likely to be reflected in the file. alternative of BUFFERED.

KEYED

public static final IPLIFile.Attr KEYED

file is defined or opened for direct or random operations such that data my be read or written in any order based on an index key. alternative of SEQUENTIAL, DIRECT

SYSIN

public static final IPLIFile.Attr SYSIN

the file is associated with the standard input of the program, allowing "piping" of information into this program. alternative of SYSOUT, SYSERR.

SYSOUT

public static final IPLIFile.Attr SYSOUT

the file is associated with the standard output of the program, allowing "piping" of information from this to another program. alternative of SYSIN, SYSERR.

SYSERR

public static final IPLIFile.Attr SYSERR

the file is associated with the standard error of the program, allowing error messages to be routed separately from standard output alternative of SYSIN, SYSOUT.

DDNAME

public static final IPLIFile.Attr DDNAME

the file is associated with a DDNAME specified on the command line or in configuration files. usually specified with Java Virtual Machine properties with -DMYDDNAME=mydsn.dat

APPEND

public static final IPLIFile.Attr APPEND

IBM Ent PL/I ENVIRONMENT attribute APPEND(Y|N) for "extend" or "open for append" mode. EPLI: implemented also with -Dddname.disp=mod set by EBP

BUFSIZE

public static final IPLIFile.Attr BUFSIZE

IBM Ent PL/I ENVIRONMENT attribute BUFSIZE(n) file buffer size. EPLI: not implemented in environment; use DCB settings

CHARSET

public static final IPLIFile.Attr CHARSET

IBM Ent PL/I ENVIRONMENT attribute CHARSET(ASIS|ASCII|EBCDIC) for file encoding character set EPLI: not implemented in environment; use DCB settings

DELAY

public static final IPLIFile.Attr DELAY

IBM Ent PL/I ENVIRONMENT attribute DELAY(0 | n) milliseconds to delay before retrying file lock EPLI: not implemented in FILE ENVIRONMENT clause; use DCB settings.

LRECL

public static final IPLIFile.Attr LRECL

IBM Ent PL/I ENVIRONMENT attribute LRECL(n) same as RECSIZE EPLI: not implemented in FILE ENVIRONMENT clause.

LRMSKIP

public static final IPLIFile.Attr LRMSKIP

IBM Ent PL/I ENVIRONMENT attribute LRMSKIP(n) The LRMSKIP option allows output to begin on the nth line of the first page for the first SKIP format item to be executed after a file is opened. n refers to the value specified with the SKIP option of the PUT or GET statement. EPLI: not implemented in FILE ENVIRONMENT clause.

PROMPT

public static final IPLIFile.Attr PROMPT

IBM Ent PL/I ENVIRONMENT attribute PROMPT(Y|N) The PROMPT option specifies whether colons should be visible as prompts for stream input from the terminal. EPLI: not implemented in FILE ENVIRONMENT clause; use DCB settings.

PUTPAGE

public static final IPLIFile.Attr PUTPAGE

IBM Ent PL/I ENVIRONMENT attribute PUTPAGE(NOCR|CR) The PUTPAGE option specifies whether the form feed character should be followed by a carriage return character. This option applies only to printer-destined files. Printer-destined files are stream output files declared with the PRINT attribute, or record output files declared with the CTLASA environment option. EPLI: not implemented in FILE ENVIRONMENT clause.

RECCOUNT

public static final IPLIFile.Attr RECCOUNT

IBM Ent PL/I ENVIRONMENT attribute RECCOUNT(n) The RECCOUNT option specifies the maximum number of records that can be loaded into a relative or regional data set that is created during the PL/I file opening process. EPLI: not implemented in FILE ENVIRONMENT clause.

RECSIZE

public static final IPLIFile.Attr RECSIZE

IBM Ent PL/I ENVIRONMENT attribute RECSIZE(n|512) The RECSIZE option specifies the length of records in the data set. For regional and fixed-length data sets, RECSIZE specifies the length of each record in the data set; for all other data set types, RECSIZE specifies the maximum length that records can have. EPLI: not implemented in FILE ENVIRONMENT clause; use DCB settings.

SAMELINE

public static final IPLIFile.Attr SAMELINE

IBM Ent PL/I ENVIRONMENT attribute SAMELINE(N|Y) The SAMELINE option specifies whether the system prompt occurs on the same line as the statement that prompts for input. EPLI: not implemented in FILE ENVIRONMENT clause; use DCB settings.

SKIP0

public static final IPLIFile.Attr SKIP0

IBM Ent PL/I ENVIRONMENT attribute SKIP0(N|Y) The SKIP0 option specifies where the line cursor moves when SKIP(0) statement is coded in the source program. SKIP0 applies to terminal files that are not linked as PM applications. EPLI: not implemented in FILE ENVIRONMENT clause.

TYPE

public static final IPLIFile.Attr TYPE

IBM Ent PL/I ENVIRONMENT attribute TYPE(LF|CRLF|TEXT|FIXED|CRLFEOF|U) The TYPE option specifies the format of records in a native file. EPLI: not implemented in FILE ENVIRONMENT clause; use DCB settings.

SHR

public static final IPLIFile.Attr SHR

IBM Ent PL/I Prog Guide describes JCL DISP arguments allowed after DSN keyword SHR - open the dataset for shared access

OLD

public static final IPLIFile.Attr OLD

IBM Ent PL/I Prog Guide describes JCL DISP arguments allowed after DSN keyword OLD - open the dataset for exclusive access

MOD

public static final IPLIFile.Attr MOD

IBM Ent PL/I Prog Guide describes JCL DISP arguments allowed after DSN keyword MOD - open the dataset for append (same as APPEND)

KEEP

public static final IPLIFile.Attr KEEP

IBM Ent PL/I Prog Guide describes JCL DISP arguments allowed after DSN keyword KEEP - after close, keep the dataset

DELETE

public static final IPLIFile.Attr DELETE

IBM Ent PL/I Prog Guide describes JCL DISP arguments allowed after DSN keyword DELETE - after close, delete the dataset

CATLG

public static final IPLIFile.Attr CATLG

IBM Ent PL/I Prog Guide describes JCL DISP arguments allowed after DSN keyword CATLG - after close, keep the dataset

UNCATLG

public static final IPLIFile.Attr UNCATLG

IBM Ent PL/I Prog Guide describes JCL DISP arguments allowed after DSN keyword UNCATLG - after close, delete the dataset

Method Detail

values

public static IPLIFile.Attr[] 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 (IPLIFile.Attr c : IPLIFile.Attr.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IPLIFile.Attr 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