eventweb.io

Class LoggingReader

java.lang.Object

java.io.Reader

java.io.BufferedReader

eventweb.io.LoggingReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable

public class LoggingReader
extends java.io.BufferedReader

Logging BufferedReader Class.

BufferedReader with logging capability.

Version:

1.1.2 09/09/10

Author:

Stephen W. Thompson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	DEP_LIST Class dependencies
static java.lang.String	VERSION Class version

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
LoggingReader(java.io.InputStream in, int sz, java.io.PrintWriter logDest, boolean setLogging) Create a new LoggingReader from an InputStream.
LoggingReader(java.io.InputStream in, java.io.PrintWriter logDest, boolean setLogging) Create a new LoggingReader from an InputStream.
LoggingReader(java.io.Reader in, int sz, java.io.PrintWriter logDest, boolean setLogging) Create a new LoggingReader from a Reader.
LoggingReader(java.io.Reader in, int sz, java.io.PrintWriter logDest, boolean setLogging, java.lang.String id) Create a new LoggingReader from a Reader.
LoggingReader(java.io.Reader in, java.io.PrintWriter logDest, boolean setLogging) Create a new LoggingReader from a Reader.
LoggingReader(java.io.Reader in, java.io.PrintWriter logDest, boolean setLogging, java.lang.String id) Create a new LoggingReader from a Reader.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	getTimestamp() Get a time-stamp string with the current time.
boolean	isTimestamping()
void	mark(int readAheadLimit) Mark the present position in the stream.
int	read() Read a single character.
int	read(char[] cbuf, int off, int len) Read characters into a portion of an array.
java.lang.String	readLine() Read a line of text.
void	reset() Reset the stream to the most recent mark.
void	setTimestamp(boolean timestamp)

Methods inherited from class java.io.BufferedReader

close, markSupported, ready, 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

Field Detail

VERSION

public static final java.lang.String VERSION

Class version

DEP_LIST

public static final java.lang.String[] DEP_LIST

Class dependencies

Constructor Detail

LoggingReader

public LoggingReader(java.io.Reader in,
             java.io.PrintWriter logDest,
             boolean setLogging)

Create a new LoggingReader from a Reader.

Parameters:

in - The underlying Reader

logDest - The log destination for I/O tracing

setLogging - If true, I/O tracing is turned on

LoggingReader

public LoggingReader(java.io.InputStream in,
             java.io.PrintWriter logDest,
             boolean setLogging)

Create a new LoggingReader from an InputStream.

Parameters:

in - The underlying InputStream

logDest - The log destination for I/O tracing

setLogging - If true, I/O tracing is turned on

LoggingReader

public LoggingReader(java.io.Reader in,
             java.io.PrintWriter logDest,
             boolean setLogging,
             java.lang.String id)

Create a new LoggingReader from a Reader.

Parameters:

in - The underlying Reader

logDest - The log destination for I/O tracing

setLogging - If true, I/O tracing is turned on

id - Source indetifier to include in log output

LoggingReader

public LoggingReader(java.io.Reader in,
             int sz,
             java.io.PrintWriter logDest,
             boolean setLogging)

Create a new LoggingReader from a Reader.

Parameters:

in - The underlying Reader

sz - The input buffer size

logDest - The log destination for I/O tracing

setLogging - If true, I/O tracing is turned on

LoggingReader

public LoggingReader(java.io.InputStream in,
             int sz,
             java.io.PrintWriter logDest,
             boolean setLogging)

Create a new LoggingReader from an InputStream.

Parameters:

in - The underlying InputStream

sz - The input buffer size

logDest - The log destination for I/O tracing

setLogging - If true, I/O tracing is turned on

LoggingReader

public LoggingReader(java.io.Reader in,
             int sz,
             java.io.PrintWriter logDest,
             boolean setLogging,
             java.lang.String id)

Create a new LoggingReader from a Reader.

Parameters:

in - The underlying Reader

sz - The input buffer size

logDest - The log destination for I/O tracing

setLogging - If true, I/O tracing is turned on

id - Source indetifier to include in log output

Method Detail

getTimestamp

public static java.lang.String getTimestamp()

Get a time-stamp string with the current time.
The time-stamp format is: HH:MM:SS.SS

Returns:

Time-stamp string

isTimestamping

public boolean isTimestamping()

setTimestamp

public void setTimestamp(boolean timestamp)

read

public int read()
         throws java.io.IOException

Read a single character.

Overrides:

read in class java.io.BufferedReader

Returns:

The character read

Throws:

java.io.IOException - If an I/O error occurs

read

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

Read characters into a portion of an array.

Overrides:

read in class java.io.BufferedReader

Parameters:

cbuf - Destination buffer

off - Offset at which to start storing characters

len - Maximum number of characters to read

Returns:

The number of characters read, or -1 if the end of the stream has been reached

Throws:

java.io.IOException - If an I/O error occurs

readLine

public java.lang.String readLine()
                          throws java.io.IOException

Read a line of text.

Overrides:

readLine in class java.io.BufferedReader

Returns:

A string containing the contents of the line, not including any line-termination characters, or null if the end of the stream has been reached

Throws:

java.io.IOException - If an I/O error occurs

mark

public void mark(int readAheadLimit)
          throws java.io.IOException

Mark the present position in the stream.

Overrides:

mark in class java.io.BufferedReader

Parameters:

readAheadLimit - Limit on the number of characters that may be read while still preserving the mark

Throws:

java.io.IOException - If an I/O error occurs

java.lang.IllegalArgumentException - If readAheadLimit is less than 0

reset

public void reset()
           throws java.io.IOException

Reset the stream to the most recent mark.

Overrides:

reset in class java.io.BufferedReader

Throws:

java.io.IOException - If an I/O error occurs