REXXFile (NetPhantom® 7.7 Java API Specification)

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

All Methods Instance Methods Concrete 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 line, 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 - Flag for creation of file if it 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.
    
    Returns:
    
    boolean indication if the file could be opened for read/write.
  - 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.
    
    Parameters:
    
    data - The data to write.
    
    line - The line to write to, can be either 0L (zero) for current position, or 1L to reset file and start writing the first line.
    
    Returns:
    
    0 for successful write, 1 for error.
  - readLine
```
public String readLine(long line,
                       long count)
                throws IOException
```
    Reads a line from the stream without the line separator.
    
    Parameters:
    
    line - line in file to read, or 0L for current line.
    
    count - Number of lines to read, 0L=no read, one or more lines to read, last line read is returned.
    
    Returns:
    
    The string result.
    
    Throws:
    
    IOException - Thrown if there is no more data to read as "NOTREADY" state.
  - 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).
    
    Returns:
    
    Success flag.
    
    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.
    
    Returns:
    
    The current stream position, one-based value, i.e. filePointerPosition + 1.
    
    Throws:
    
    IOException
  - leftOver
```
public long leftOver()
```
    Returns the number of bytes after the current position to the end of the file.
    
    Returns:
    
    The number of bytes left to read from the current position.
  - write
```
public long write(String data,
                  long position)
           throws IOException
```
    Writes a string of data to the requested position.
    
    Parameters:
    
    data - Data to write.
    
    position - Position in file to write to, ONE-based!
    
    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.
    
    Returns:
    
    The file last modified date in UTC formatted as RFC 1123, i.e. in Java date format EEE, dd MMM yyyy HH:mm:ss 'GMT', e.g. Sun, 21 Feb 2022 12:16:24 GMT.
  - 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, otherwise the error state.

Class REXXFile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

REXXFile

REXXFile

Method Detail

dispose

exists

isOpen

isWritable

isReadable

isReadWrite

getPath

open

open

close

fileSize

writeLine

readLine

read

seek

position

leftOver

write

date

setException

getException