com.goldencode.p2j.util

Interface StreamBuilder

All Known Implementing Classes:

StreamDaemon

public interface StreamBuilder

An interface providing remote construction of file and process streams.

Method Summary

Modifier and Type	Method and Description
int	openClipboardStream() Constructs the output stream into the client's system clipboard.
int	openDirStream(java.lang.String dir, boolean noAttrList) Constructs a remote stream instance representing the OsDirStream result of the INPUT THROUGH OS-DIR (dir-name) statement.
int	openFileStream(java.lang.String filename, boolean write, boolean append, boolean hasDuplicatedLastLine) Constructs a remote stream instance representing a file using a filename, this file or device will be opened for reading or writing based on the given write flag.
int	openPrinterStream(java.lang.String name, PrintOptions options) Constructs a remote printer stream instance.
int	openProcessStream() Constructs a remote stream instance representing a process' standard I/O.
int	openTerminalStream() Constructs a remote stream instance representing the terminal.

Method Detail

openFileStream

int openFileStream(java.lang.String filename,
                   boolean write,
                   boolean append,
                   boolean hasDuplicatedLastLine)
            throws ErrorConditionException

Constructs a remote stream instance representing a file using a filename, this file or device will be opened for reading or writing based on the given write flag. The current read/write position will be at offset 0 unless in write mode and the append flag is on (in which case the write position will be at the end of the file).

This stream will NOT have paging active.

Parameters:

filename - The name of the file or device to open. Must not be null.

write - If true, open in write mode, otherwise open the file for reading.

append - In write mode, if true, the current file pointer is set to the end of the file. Otherwise if in write mode, the file is truncated to 0 length. This value is ignored in read mode.

hasDuplicatedLastLine - Flag to indicate if the last line in the file is duplicate (true for LOB files).

Returns:

The stream id which is used to route operations to the newly created instance.

Throws:

ErrorConditionException - If the file does not exist OR if the current user does not have the proper rights to open the file or device.

openProcessStream

int openProcessStream()

Constructs a remote stream instance representing a process' standard I/O.

Returns:

The stream id which is used to route operations to the newly created instance.

openClipboardStream

int openClipboardStream()

Constructs the output stream into the client's system clipboard.

Returns:

The stream id which is used to route operations to the newly created instance.

openDirStream

int openDirStream(java.lang.String dir,
                  boolean noAttrList)

Constructs a remote stream instance representing the OsDirStream result of the INPUT THROUGH OS-DIR (dir-name) statement.

This will take the directory and export the list of files, directory and device names and properties.

Parameters:

dir - The String path to the directory on which OS-DIR will be applied.

noAttrList - true if property indexes will be added to the results.

Returns:

The stream id which is used to route operations to the newly created instance.

openTerminalStream

int openTerminalStream()

Constructs a remote stream instance representing the terminal.

Returns:

The stream id which is used to route operations to the newly created instance.

openPrinterStream

int openPrinterStream(java.lang.String name,
                      PrintOptions options)

Constructs a remote printer stream instance. This can be assigned as unnamed output (OUTPUT TO PRINTER statement) or as a named stream (OUTPUT STREAM someStream TO PRINTER).

Parameters:

name - The name of the target printer.

options - Print options.

Returns:

The stream id which is used to route operations to the newly created instance.