bsh

Class PlexReader

java.lang.Object

java.io.Reader

java.io.FilterReader

bsh.PlexReader

All Implemented Interfaces:

java.io.Closeable, java.lang.Readable

public class PlexReader
extends java.io.FilterReader

The PlexReader class is a wrapper for the input Reader for interactive Interpreter instances. We intercept the read() operations, and when input logging is enabled, we write (with conversion if needed) the chars read() into a log file. Such a file can be read and executed later via the source() command, for instance.

Field Summary

Fields inherited from class java.io.FilterReader

in

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
PlexReader(java.io.Reader in, java.lang.String ws_name) Constructor PlexReader, only called by PlexInterpreter().

Method Summary

Methods

Modifier and Type	Method and Description
void	enable(java.lang.String log_name) Enable logging, making sure that there is an underlying logstream.
java.lang.String	log_status() Return a String describing the logging status, including defaults.
int	read(char[] buf, int off, int len) Wrapper for normal read to buffer operation.
static void	setDefaultDir(java.lang.String pathname) Set the default logging directory.
static void	setDefaultFlag(boolean flag) Set the default logging flag.
void	setLogfile(java.lang.String new_log_name) Force logstream to go to specified filename.

Methods inherited from class java.io.FilterReader

close, mark, markSupported, read, ready, reset, skip

Methods inherited from class java.io.Reader

read, read

Methods inherited from class java.lang.Object

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

Constructor Detail

PlexReader

public PlexReader(java.io.Reader in,
          java.lang.String ws_name)

Constructor PlexReader, only called by PlexInterpreter(). We ignore the name argument.

Parameters:

in - Input Reader for an interative interpreter instance.

ws_name - Workspace name, which we ignore.

Method Detail

enable

public void enable(java.lang.String log_name)
            throws java.io.IOException

Enable logging, making sure that there is an underlying logstream.

Parameters:

log_name - Name to use as logfile, or null, if the default is okay.

Throws:

java.io.IOException

setLogfile

public void setLogfile(java.lang.String new_log_name)

Force logstream to go to specified filename.

Parameters:

new_log_name - Name to use as logfile -- must be the name of a writable file.

read

public int read(char[] buf,
       int off,
       int len)
         throws java.io.IOException

Wrapper for normal read to buffer operation. If logging is on, log the characters that were read, otherwise, do nothing.

Overrides:

read in class java.io.FilterReader

Parameters:

buf - Where to write the characters read.

off - Offset at which to start writing the characters.

len - Max number of characters to read.

Returns:

Number of characters read.

Throws:

java.io.IOException

setDefaultFlag

public static void setDefaultFlag(boolean flag)

Set the default logging flag. The default default is false. Invoked via the setLogging() command.

Parameters:

flag - If true, input logging is on by default, else off.

log_status

public java.lang.String log_status()

Return a String describing the logging status, including defaults.

Returns:

Log status string.

setDefaultDir

public static void setDefaultDir(java.lang.String pathname)

Set the default logging directory. The default default is ~/plex. Invoked via the setLogging() command.

Parameters:

pathname - Set the default directory in which to store log files.