se.entra.phantom.server

Class REXXFile

java.lang.Object

se.entra.phantom.server.REXXFile

public class REXXFile
extends Object

Handles the REXX files functions such as LineOut, Chars, CharIn, etc. The PhantomWorker class keeps a hash table with names as keys and this class instance as element data.

Constructor Summary

Constructors

Constructor and Description
REXXFile(String filename) Creates a REXXFile instance that represents the file whose pathname is given as the path argument.
REXXFile(String filename, boolean create) Creates a REXXFile instance that represents the file whose pathname is given as the path argument.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	close() Closes the file.
String	date() Gets the last modified date of the file.
void	dispose() Disposes of the file (makes sure it's closed).
boolean	exists() Tests if the file exists.
long	fileSize() Checks the number of bytes that remain to be read.
String	getException() Gets the current file exception after an error.
String	getPath() Gets the real path for the file.
boolean	isOpen() Checks if the file is opened.
boolean	isReadable() Checks if the file is readable.
boolean	isReadWrite() Flag indicating the file is read- and writable.
boolean	isWritable() Checks if the file is writable.
long	leftOver() Returns the number of bytes after the current position to the end of the file.
boolean	open() Opens the file for Read and/or Write depending on R/W status of REXXFile.
boolean	open(boolean create) Opens the file.
long	position() Gets the current position in the stream.
String	read(int length, long position) Read and codepage convert data from stream.
String	readLine(long pos, long count) Reads a line from the stream without the line separator.
boolean	seek(long position) Seek a position in a file.
void	setException(String e) Sets a string as the error for the exception.
long	write(String data, long position) Writes a string of data to the requested position.
int	writeLine(String data, long line) Writes a line a text to the stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

REXXFile

public REXXFile(String filename,
        boolean create)

Creates a REXXFile instance that represents the file whose pathname is given as the path argument.

Parameters:

filename - the file name and path.

create - if file does not exist.

REXXFile

public REXXFile(String filename)

Creates a REXXFile instance that represents the file whose pathname is given as the path argument.

Parameters:

filename - the file name and path.

Method Detail

dispose

public void dispose()

Disposes of the file (makes sure it's closed).

exists

public boolean exists()

Tests if the file exists. (Checks security with SecurityManager).

Returns:

true if file exists and is allowed to be read; false otherwise.

isOpen

public boolean isOpen()

Checks if the file is opened.

isWritable

public boolean isWritable()

Checks if the file is writable.

isReadable

public boolean isReadable()

Checks if the file is readable.

isReadWrite

public boolean isReadWrite()

Flag indicating the file is read- and writable.

getPath

public String getPath()

Gets the real path for the file.

open

public boolean open(boolean create)

Opens the file. Creates the file if necessary. Note that this is only meaningful for writable files.

Parameters:

create - if does not exist.

open

public boolean open()

Opens the file for Read and/or Write depending on R/W status of REXXFile.

Returns:

false if the file couldn't be opened.

close

public boolean close()

Closes the file.

Returns:

false if the file got errors during closing of the file.

fileSize

public long fileSize()

Checks the number of bytes that remain to be read.

Returns:

long number of bytes in the entire stream.

writeLine

public int writeLine(String data,
            long line)

Writes a line a text to the stream.

Returns:

int 0 for successful write, 1 for error.

readLine

public String readLine(long pos,
              long count)
                throws IOException

Reads a line from the stream without the line separator.

Parameters:

   pos     line in file to read, or 0 for current line.
   count   Number of lines to read, 0=no read, 1 read one line.
 

Throws:

IOException

read

public String read(int length,
          long position)
            throws IOException

Read and codepage convert data from stream.

Parameters:

length - length to read (0 for a seek to position).

position - offset to start reading data from stream.

Returns:

String containing the data read.

Throws:

IOException

seek

public boolean seek(long position)
             throws IOException

Seek a position in a file.

Parameters:

position - offset to seek to (position<0 for current position).

Throws:

IOException

position

public long position()
              throws IOException

Gets the current position in the stream. If the stream is not opened, it will be opened.

Throws:

IOException

leftOver

public long leftOver()

Returns the number of bytes after the current position to the end of the file.

write

public long write(String data,
         long position)
           throws IOException

Writes a string of data to the requested position.

Returns:

long the number of bytes remaining to write to the stream.

Throws:

IOException

date

public String date()

Gets the last modified date of the file.

setException

public void setException(String e)

Sets a string as the error for the exception.

getException

public String getException()

Gets the current file exception after an error.

Returns:

null if no error has occurred.