org.mdiutil.lang

Class ProcessHandler

java.lang.Object

org.mdiutil.lang.ProcessHandler

public class ProcessHandler
extends Object

This class allows to handle the input and output streams of an external process. The class allows to listen to:

• The output stream and the error stream of the process
• Optionally the input stream of the process

The class used internally StreamGobbler instances to communicate with the out and err stream of the process.

Since:

1.3.20

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProcessHandler.ProcessListener A listener which listens to the ProcessHandler streams.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_POLLING_RATE The default polling rate.

Constructor Summary

Constructors

Constructor and Description
ProcessHandler(Process process) Constructor.
ProcessHandler(Process process, boolean handleInputStream) Constructor.The output and error streams of the proces will be handled.
ProcessHandler(ProcessBuilder builder) Constructor.
ProcessHandler(ProcessBuilder builder, boolean handleInputStream) Constructor.The output and error streams of the proces will be handled.

Method Summary

Modifier and Type	Method and Description
void	close() Close the reading and writing of the streams.
void	createProcessAndStart() Creates the process if it does not already exist and start the handler.
Charset	getCharset() Return the charset used to communcate with the process.
ProcessHandler.ProcessListener	getListener() Return the process listener.
Process	getProcess() Return the process.
boolean	isClosed() Return true if the handler is closed.
boolean	isHandlingInputStream() Return true if the input stream of the process is started.
boolean	isStarted() Return true if the handler is started.
void	setCharset(Charset charset) Set the charset used to communcate with the process.
void	setCharset(String charset) Set the charset used to communcate with the process.
boolean	setInputQueued(boolean isQueued) Set if the input stream is queued.It will not do anything if the handler is already started.
boolean	setInputQueued(boolean isQueued, int delay) Set if the input stream is queued.It will not do anything if the handler is already started.
boolean	setInputQueued(boolean isQueued, int delay, int pollingRate) Set if the input stream is queued.It will not do anything if the handler is already started.
void	setListener(ProcessHandler.ProcessListener listener) Set the process listener.
boolean	setOutputQueued(boolean isQueued) Set if the error and output streams are queued.
boolean	setOutputQueued(boolean isQueued, int delay) Set if the error and output streams are queued.
boolean	setOutputQueued(boolean isQueued, int delay, int pollingRate) Set if the error and output streams are queued.It will not do anything if the handler is already started.
boolean	start() Start the handler.
boolean	writeIn(String line, boolean includeNewLine) Write a line of text to the input stream.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_POLLING_RATE

public static final int DEFAULT_POLLING_RATE

The default polling rate.

See Also:

Constant Field Values

Constructor Detail

ProcessHandler

public ProcessHandler(ProcessBuilder builder)

Constructor. The output and error streams of the proces will be handled.

Parameters:

builder - the process builder

ProcessHandler

public ProcessHandler(ProcessBuilder builder,
                      boolean handleInputStream)

Constructor.The output and error streams of the proces will be handled. The input stream can be optionally handled.

Parameters:

builder - the process builder

handleInputStream - true if the input stream will be handled

ProcessHandler

public ProcessHandler(Process process)

Constructor. The output and error streams of the proces will be handled.

Parameters:

process - the process

ProcessHandler

public ProcessHandler(Process process,
                      boolean handleInputStream)

Constructor.The output and error streams of the proces will be handled. The input stream can be optionally handled.

Parameters:

process - the process

handleInputStream - true if the input stream will be handled

Method Detail

setCharset

public void setCharset(Charset charset)

Set the charset used to communcate with the process.

Parameters:

charset - the charset

setCharset

public void setCharset(String charset)

Set the charset used to communcate with the process.

Parameters:

charset - the charset

getCharset

public Charset getCharset()

Return the charset used to communcate with the process.

Returns:

the charset

getProcess

public Process getProcess()

Return the process.

Returns:

the process

setListener

public void setListener(ProcessHandler.ProcessListener listener)

Set the process listener.

Parameters:

listener - the listener

getListener

public ProcessHandler.ProcessListener getListener()

Return the process listener.

Returns:

the listener

setOutputQueued

public boolean setOutputQueued(boolean isQueued)

Set if the error and output streams are queued. It will not do anything if the handler is already started.

Parameters:

isQueued - true if the output streams are queued

Returns:

true if the queue could be configured

setOutputQueued

public boolean setOutputQueued(boolean isQueued,
                               int delay)

Set if the error and output streams are queued. It will not do anything if the handler is already started.

Parameters:

isQueued - true if the output streams are queued

delay - the queueing delay

Returns:

true if the queue could be configured

setOutputQueued

public boolean setOutputQueued(boolean isQueued,
                               int delay,
                               int pollingRate)

Set if the error and output streams are queued.It will not do anything if the handler is already started.

Parameters:

isQueued - true if the output streams are queued

delay - the queueing delay

pollingRate - the polling rate of the queues

Returns:

true if the queue could be configured

setInputQueued

public boolean setInputQueued(boolean isQueued)

Set if the input stream is queued.It will not do anything if the handler is already started.

Parameters:

isQueued - true if the input stream is queued

Returns:

true if the queue could be configured

setInputQueued

public boolean setInputQueued(boolean isQueued,
                              int delay)

Set if the input stream is queued.It will not do anything if the handler is already started.

Parameters:

isQueued - true if the input stream is queued

delay - the queueing delay

Returns:

true if the queue could be configured

setInputQueued

public boolean setInputQueued(boolean isQueued,
                              int delay,
                              int pollingRate)

Set if the input stream is queued.It will not do anything if the handler is already started.

Parameters:

isQueued - true if the input stream is queued

delay - the queueing delay

pollingRate - the polling rate

Returns:

true if the queue could be configured

close

public void close()

Close the reading and writing of the streams.

isHandlingInputStream

public boolean isHandlingInputStream()

Return true if the input stream of the process is started.

Returns:

true if the input stream of the process is started

isStarted

public boolean isStarted()

Return true if the handler is started.

Returns:

true if the handler is started

isClosed

public boolean isClosed()

Return true if the handler is closed.

Returns:

true if the handler is closed

createProcessAndStart

public void createProcessAndStart()
                           throws IOException

Creates the process if it does not already exist and start the handler.

Throws:

IOException - if an I/O error occurs

start

public boolean start()

Start the handler.

Returns:

true if the process was already started.

writeIn

public boolean writeIn(String line,
                       boolean includeNewLine)

Write a line of text to the input stream.

Parameters:

line -

includeNewLine - true if a new lilne must be handled

Returns:

true if the line of text will be written. it will return false if isHandlingInputStream() is true, and the handler is not closed.