edu.illinois.ncsa.datawolf.executor.hpc.util

Class OutputPipe

java.lang.Object

java.io.OutputStream

edu.illinois.ncsa.datawolf.executor.hpc.util.OutputPipe

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class OutputPipe
extends OutputStream

General-purpose pipe for capturing data written to an output stream. Modes of usage: (a) write to log; (b) write to file; (c) read a chunk at a time (consume the buffer).

Author:

Albert L. Rossi

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	append
protected boolean	buffer
protected BufferedWriter	bw
protected boolean	error
protected File	fout
protected boolean	log
protected static org.slf4j.Logger	logger
protected String	reply
protected StringBuffer	sb

Constructor Summary

Constructors

Constructor and Description
OutputPipe()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Nulls out the buffer.
void	flush() If log is true, logs the current buffer as info; if file exists, writes it to file and flushes.
String	readReply() Sets reply to empty after read.
void	setAppend(boolean b)
void	setBuffer(boolean b)
void	setError(boolean b)
void	setFile(File f)
void	setLog(boolean b)
void	write(int bigbyte) Appends to string buffer.

Methods inherited from class java.io.OutputStream

write, write

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static org.slf4j.Logger logger

sb

protected StringBuffer sb

reply

protected String reply

fout

protected File fout

log

protected boolean log

buffer

protected boolean buffer

append

protected boolean append

error

protected boolean error

bw

protected BufferedWriter bw

Constructor Detail

OutputPipe

public OutputPipe()

Method Detail

close

public void close()

Nulls out the buffer.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

flush

public void flush()
           throws IOException

If log is true, logs the current buffer as info; if file exists, writes it to file and flushes. If buffer is set to true, appends to the current reply string and zeros-out the buffer.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

readReply

public String readReply()

Sets reply to empty after read.

Returns:

the reply.

setAppend

public void setAppend(boolean b)

Parameters:

b - if true, append to the indicated file (default=false).

setBuffer

public void setBuffer(boolean b)

Parameters:

b - if true, stores received output in a buffer to be read (default=true).

setError

public void setError(boolean b)

Parameters:

b - if true, this stream represents an error stream.

setFile

public void setFile(File f)

Parameters:

f - file to which to write output.

setLog

public void setLog(boolean b)

Parameters:

b - if true, log message as INFO or ERROR (if an error stream).

write

public void write(int bigbyte)
           throws IOException

Appends to string buffer.

Specified by:

write in class OutputStream

Parameters:

bigbyte - int representation of a byte to write.

Throws:

IOException - if output exceeds memory, or if the stream has been closed.