com.heirloomcomputing.epli.runtime

Class PLIFile

java.lang.Object

com.heirloomcomputing.epli.runtime.PLIFile

public class PLIFile
extends java.lang.Object

PLIFile is a factory class that constructs either an Elastic PL/I Stream I/O (PLIStream) or Record I/O (PLIRecord) object, which it might do on the New() or Open() operators since that is where RECORD or STREAM may be specified or implied by other attributes (or none at all) to make the determination

Requires access to ecobol.jar in order to function

Author:

Heirloom Computing, Inc.

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
static java.lang.String	NOCOBOLMSG warning msg
static java.util.HashMap<java.lang.String,IPLIFile>	OpenFiles keep track of all open files

Constructor Summary

Constructors

Constructor and Description
PLIFile() PLIFile constructor should not be used

Method Summary

Modifier and Type	Method and Description
static void	CloseAll() close and free all New'd file
static void	Free(java.lang.String ddName) close and free a New'd file
static IPLIFile	New(java.lang.String ddName, java.util.EnumSet<IPLIFile.Attr> declareFileAttributes) New() looks at the attributes and constructs either a PLIRecord or PLIStream
static IPLIFile	New(java.lang.String ddName, java.util.EnumSet<IPLIFile.Attr> declareFileAttributes, java.lang.String title, java.lang.String environment) New() looks at the attributes and constructs either a PLIRecord or PLIStream
static IPLIFile	New(java.lang.String ddName, java.util.EnumSet<IPLIFile.Attr> declareFileAttributes, java.lang.String title, java.lang.String environment, int lineSize, int pageSize) New() looks at the attributes and constructs either a PLIRecord or PLIStream
static IPLIFile	Open(IPLIFile dclFile, java.util.EnumSet<IPLIFile.Attr> openFileAttributes) Open modifies a previously declared IPLIFile set of attributes (possibly switching its type) and opens the file the file for reading
static IPLIFile	Open(IPLIFile dclFile, java.util.EnumSet<IPLIFile.Attr> openFileAttributes, java.lang.String title, java.lang.String environment) Open modifies a previously declared IPLIFile set of attributes (possibly switching its type) and opens the file the file for reading
static IPLIFile	Open(IPLIFile dclFile, java.util.EnumSet<IPLIFile.Attr> openFileAttributes, java.lang.String title, java.lang.String environment, int lineSize, int pageSize) Open modifies a previously declared IPLIFile set of attributes (possibly switching its type) and opens the file the file for reading

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

NOCOBOLMSG

public static final java.lang.String NOCOBOLMSG

warning msg

See Also:

Constant Field Values

OpenFiles

public static java.util.HashMap<java.lang.String,IPLIFile> OpenFiles

keep track of all open files

Constructor Detail

PLIFile

public PLIFile()

PLIFile constructor should not be used

Method Detail

New

public static IPLIFile New(java.lang.String ddName,
                           java.util.EnumSet<IPLIFile.Attr> declareFileAttributes,
                           java.lang.String title,
                           java.lang.String environment,
                           int lineSize,
                           int pageSize)

New() looks at the attributes and constructs either a PLIRecord or PLIStream

Parameters:

ddName - - the name of the FILE constant within the user program, which is the DD name for the file unless overridden by other attributes

declareFileAttributes - - a set of attributes for creating the file

title - - the PL/I TITLE attribute specifying an alternate DDNAME or specific dataset name or file PATH of the file to open

environment - - the PL/I ENVIRONMENT attribute specifying file, record and block size attributes of the file

lineSize - - the number of characters in a PRINT STREAM file

pageSize - - the number of lines on a page in a PRINT STREAM file

Returns:

a class that implements IPLIFile to provide stream or record I/O

New

public static IPLIFile New(java.lang.String ddName,
                           java.util.EnumSet<IPLIFile.Attr> declareFileAttributes,
                           java.lang.String title,
                           java.lang.String environment)

New() looks at the attributes and constructs either a PLIRecord or PLIStream

Parameters:

ddName - - the name of the FILE constant within the user program, which is the DD name for the file unless overridden by other attributes

declareFileAttributes - - a set of attributes for creating the file

title - - the PL/I TITLE attribute specifying an alternate DDNAME or specific dataset name or file PATH of the file to open

environment - - the PL/I ENVIRONMENT attribute specifying file, record and block size attributes of the file

Returns:

a class that implements IPLIFile to provide stream or record I/O

New

public static IPLIFile New(java.lang.String ddName,
                           java.util.EnumSet<IPLIFile.Attr> declareFileAttributes)

New() looks at the attributes and constructs either a PLIRecord or PLIStream

Parameters:

ddName - - the name of the FILE constant within the user program, which is the DD name for the file unless overridden by other attributes

declareFileAttributes - - a set of attributes for creating the file

Returns:

a class that implements IPLIFile to provide stream or record I/O

Open

public static IPLIFile Open(IPLIFile dclFile,
                            java.util.EnumSet<IPLIFile.Attr> openFileAttributes,
                            java.lang.String title,
                            java.lang.String environment,
                            int lineSize,
                            int pageSize)

Open modifies a previously declared IPLIFile set of attributes (possibly switching its type) and opens the file the file for reading

Parameters:

dclFile - - the IPLIFile that was used to declare the file or null if this is a new one

openFileAttributes - - a set of attributes for creating the file

title - - the PL/I TITLE attribute specifying an alternate DDNAME or specific dataset name or file PATH of the file to open

environment - - the PL/I ENVIRONMENT attribute specifying file, record and block size attributes of the file

lineSize - - the number of characters in a PRINT STREAM file

pageSize - - the number of lines on a page in a PRINT STREAM file

Returns:

an IPLIFile as either the one given it, modified with the new attributes, or a totally New() one if they have changed significantly

Open

public static IPLIFile Open(IPLIFile dclFile,
                            java.util.EnumSet<IPLIFile.Attr> openFileAttributes,
                            java.lang.String title,
                            java.lang.String environment)

Open modifies a previously declared IPLIFile set of attributes (possibly switching its type) and opens the file the file for reading

Parameters:

dclFile - - the IPLIFile that was used to declare the file or null if this is a new one

openFileAttributes - - a set of attributes for creating the file

title - - the PL/I TITLE attribute specifying an alternate DDNAME or specific dataset name or file PATH of the file to open

environment - - the PL/I ENVIRONMENT attribute specifying file, record and block size attributes of the file

Returns:

an IPLIFile as either the one given it, modified with the new attributes, or a totally New() one if they have changed significantly

Open

public static IPLIFile Open(IPLIFile dclFile,
                            java.util.EnumSet<IPLIFile.Attr> openFileAttributes)

Open modifies a previously declared IPLIFile set of attributes (possibly switching its type) and opens the file the file for reading

Parameters:

dclFile - - the IPLIFile that was used to declare the file or null if thi)s is a new one

openFileAttributes - - a set of attributes for creating the file

Returns:

an IPLIFile as either the one given it, modified with the new attributes, or a totally New() one if they have changed significantly

Free

public static void Free(java.lang.String ddName)

close and free a New'd file

Parameters:

ddName - - the ddname of the file to free

CloseAll

public static void CloseAll()

close and free all New'd file