repicea.multiprocess

Class CmdProcess

java.lang.Object

repicea.multiprocess.CmdProcess

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, java.util.concurrent.Future<java.lang.Integer>, IndependentProcess

public class CmdProcess
extends java.lang.Object

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface repicea.multiprocess.IndependentProcess

IndependentProcess.StateValue

Constructor Summary

Constructors

Constructor and Description
CmdProcess(java.util.List<java.lang.String> commands) Sub constructor with the commands only.
CmdProcess(java.util.List<java.lang.String> commands, java.io.File workingDirectory) General constructor.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) This method add a listener to the instance of this class if it is not already included in the listeners list.
boolean	cancel(boolean mayInterruptIfRunning)
protected java.lang.Process	createIndependentProcess() This method creates the proper Process instance according to the derived class.
void	execute() This method starts the independent process.
protected void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
java.lang.Integer	get()
java.lang.Integer	get(long duration, java.util.concurrent.TimeUnit timeUnit)
java.lang.String	getName() This method returns the name of the process.
IndependentProcess.StateValue	getState() This method returns the state of the process which can be either PENDING, STARTED, or DONE.
boolean	isCancelled()
boolean	isDone()
void	redirectOutputStream(boolean redirectOutputStream) This method enables the redirection of the outputstream of the independent process into the outputstream of this outer process (this process).
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) This method removes all the instances of the listener among the listeners of this class.
void	run()
void	sendObjectToProcess(java.io.Serializable obj) This method makes it possible to send a Serializable object to the independent process, typically a callback process.
void	setName(java.lang.String name) This method sets the name of this process.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmdProcess

public CmdProcess(java.util.List<java.lang.String> commands,
                  java.io.File workingDirectory)

General constructor.

Parameters:

commands - the list of commands

workingDirectory - the working directory for the process

CmdProcess

public CmdProcess(java.util.List<java.lang.String> commands)

Sub constructor with the commands only.

Parameters:

commands - the list of commands

Method Detail

createIndependentProcess

protected java.lang.Process createIndependentProcess()
                                              throws java.io.IOException

This method creates the proper Process instance according to the derived class.

Returns:

a Process object

Throws:

java.io.IOException

getName

public java.lang.String getName()

Description copied from interface: IndependentProcess

This method returns the name of the process.

Specified by:

getName in interface IndependentProcess

Returns:

a String

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface java.util.concurrent.Future<java.lang.Integer>

get

public java.lang.Integer get()
                      throws java.lang.InterruptedException,
                             java.util.concurrent.ExecutionException

Specified by:

get in interface java.util.concurrent.Future<java.lang.Integer>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

get

public java.lang.Integer get(long duration,
                             java.util.concurrent.TimeUnit timeUnit)
                      throws java.lang.InterruptedException,
                             java.util.concurrent.ExecutionException,
                             java.util.concurrent.TimeoutException

Specified by:

get in interface java.util.concurrent.Future<java.lang.Integer>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface java.util.concurrent.Future<java.lang.Integer>

getState

public IndependentProcess.StateValue getState()

This method returns the state of the process which can be either PENDING, STARTED, or DONE. As soon as the execute method is called the state changes from PENDING to STARTED. At the end of the process, the State shifts to DONE.

Returns:

a StateValue enum var

isDone

public boolean isDone()

Specified by:

isDone in interface java.util.concurrent.Future<java.lang.Integer>

run

public void run()

Specified by:

run in interface java.lang.Runnable

firePropertyChange

protected void firePropertyChange(java.lang.String propertyName,
                                  java.lang.Object oldValue,
                                  java.lang.Object newValue)

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Description copied from interface: IndependentProcess

This method add a listener to the instance of this class if it is not already included in the listeners list. The listeners are communicated the changes of the state member as well as the message received from the process itself.

Specified by:

addPropertyChangeListener in interface IndependentProcess

Parameters:

listener - a PropertyChangeListener instance

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Description copied from interface: IndependentProcess

This method removes all the instances of the listener among the listeners of this class.

Specified by:

removePropertyChangeListener in interface IndependentProcess

Parameters:

listener - a PropertyChangeListener instance

execute

public void execute()

Description copied from interface: IndependentProcess

This method starts the independent process. Can be called only once.

Specified by:

execute in interface IndependentProcess

setName

public void setName(java.lang.String name)

Description copied from interface: IndependentProcess

This method sets the name of this process.

Specified by:

setName in interface IndependentProcess

Parameters:

name - a String

sendObjectToProcess

public void sendObjectToProcess(java.io.Serializable obj)
                         throws java.io.IOException

Description copied from interface: IndependentProcess

This method makes it possible to send a Serializable object to the independent process, typically a callback process.

Specified by:

sendObjectToProcess in interface IndependentProcess

Parameters:

obj - a Serializable object

Throws:

java.io.IOException

redirectOutputStream

public void redirectOutputStream(boolean redirectOutputStream)

This method enables the redirection of the outputstream of the independent process into the outputstream of this outer process (this process). By default, the redirection is set to true.

Parameters:

redirectOutputStream - true to enable or false to disable