com.github.geko444.im4java.process

Class ProcessStarter

java.lang.Object

com.github.geko444.im4java.process.ProcessStarter

Direct Known Subclasses:

ImageCommand

public class ProcessStarter
extends Object

This class implements the processing of os-commands using a ProcessBuilder.

This is the core class of the im4java-library where all the magic takes place. It does add some overhead compared to a direct call of ProcessBuilder, but you gain additional features like piping and asynchronous execution.

Since:

0.95

Version:

$Revision: 1.38 $

Author:

$Author: bablokb $

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFER_SIZE Buffer size of process input-stream (used for reading the output (sic!) of the process).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProcessStarter() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addProcessEventListener(ProcessEventListener pListener) Add a ProcessEventListener to this ProcessStarter.
void	addProcessListener(ProcessListener pProcessListener) Deprecated. use addProcessEventListener(com.github.geko444.im4java.process.ProcessEventListener) instead
protected void	finished(Exception pException) Post-processing after the process has terminated with an exception.
protected void	finished(int pReturnCode) Post-processing after the process has terminated.
static String	getGlobalSearchPath() Query the global (static) search path.
int	getPID() Query the process-id.
protected ProcessTask	getProcessTask(LinkedList<String> pArgs) Return a ProcessTask for future execution.
String	getSearchPath() Query the per object search path.
boolean	isAsyncMode() Query the async-execution mode.
void	removeProcessEventListener(ProcessEventListener pListener) Remove a ProcessEventListener from this ProcessStarter.
protected int	run(LinkedList<String> pArgs) Execute the command.
String	searchForCmd(String pCmd, String pPath) Query the per object search path.
void	setAsyncMode(boolean pAsyncMode) Set the async-execution mode.
void	setErrorConsumer(ErrorConsumer pErrorConsumer) Set the ErrorConsumer for the stderr of the ProcessStarter.
static void	setGlobalSearchPath(String pGlobalSearchPath) Set the global (static) search path.
void	setInputProvider(InputProvider pInputProvider) Set the InputProvider for the ProcessStarter (if used as a pipe).
void	setOutputConsumer(OutputConsumer pOutputConsumer) Set the OutputConsumer for the ProcessStarter (if used as a pipe).
void	setPID(int pPID) Set the process-id of this ProcessStarter.
static void	setPIDCounter(int pPID) Set the process-id counter of the class.
void	setSearchPath(String pSearchPath) Set the per object search path.

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER_SIZE

public static final int BUFFER_SIZE

Buffer size of process input-stream (used for reading the output (sic!) of the process). Currently 64KB.

See Also:

Constant Field Values

Constructor Detail

ProcessStarter

protected ProcessStarter()

Constructor.

Method Detail

setInputProvider

public void setInputProvider(InputProvider pInputProvider)

Set the InputProvider for the ProcessStarter (if used as a pipe).

setOutputConsumer

public void setOutputConsumer(OutputConsumer pOutputConsumer)

Set the OutputConsumer for the ProcessStarter (if used as a pipe).

setErrorConsumer

public void setErrorConsumer(ErrorConsumer pErrorConsumer)

Set the ErrorConsumer for the stderr of the ProcessStarter.

addProcessEventListener

public void addProcessEventListener(ProcessEventListener pListener)

Add a ProcessEventListener to this ProcessStarter.

Parameters:

pListener - the ProcessEventListener to add

removeProcessEventListener

public void removeProcessEventListener(ProcessEventListener pListener)

Remove a ProcessEventListener from this ProcessStarter.

Parameters:

pListener - the ProcessEventListener to remove

addProcessListener

public void addProcessListener(ProcessListener pProcessListener)

Deprecated. use addProcessEventListener(com.github.geko444.im4java.process.ProcessEventListener) instead

Add a ProcessListener to this ProcessStarter.

Parameters:

pProcessListener - the ProcessListener to add

run

protected int run(LinkedList<String> pArgs)
           throws IOException,
                  InterruptedException,
                  Exception

Execute the command.

Parameters:

pArgs - arguments for ProcessBuilder

Throws:

IOException

InterruptedException

Exception

getProcessTask

protected ProcessTask getProcessTask(LinkedList<String> pArgs)

Return a ProcessTask for future execution.

Parameters:

pArgs - arguments for ProcessBuilder

setAsyncMode

public void setAsyncMode(boolean pAsyncMode)

Set the async-execution mode.

Parameters:

pAsyncMode - the iAsyncMode to set

isAsyncMode

public boolean isAsyncMode()

Query the async-execution mode.

Returns:

the iAsyncMode

setGlobalSearchPath

public static void setGlobalSearchPath(String pGlobalSearchPath)

Set the global (static) search path. You can override this search path on a per object basis.

Parameters:

pGlobalSearchPath - the global search path

getGlobalSearchPath

public static String getGlobalSearchPath()

Query the global (static) search path.

setSearchPath

public void setSearchPath(String pSearchPath)

Set the per object search path. This overrides the global search path (if set).

Parameters:

pSearchPath - the search path

getSearchPath

public String getSearchPath()

Query the per object search path.

setPIDCounter

public static void setPIDCounter(int pPID)

Set the process-id counter of the class.

Parameters:

pPID - the process-id

setPID

public void setPID(int pPID)

Set the process-id of this ProcessStarter.

Parameters:

pPID - the process-id

getPID

public int getPID()

Query the process-id.

finished

protected void finished(int pReturnCode)
                 throws Exception

Post-processing after the process has terminated. Subclasses might override this method to do some specific post-processing.

Parameters:

pReturnCode - the return-code of the process

Throws:

Exception

finished

protected void finished(Exception pException)
                 throws Exception

Post-processing after the process has terminated with an exception. Subclasses might override this method to do some specific post-processing. This method is only called in asynchronous execution mode (in synchronous mode, the exception just propagates as usual to the caller).

Note that if this method throws an exception in asynchronous execution mode, the original exception is lost and not propagated to any ProcessEventListeners. Therefore, you should take care to fill in any exception and stack-trace information.

Parameters:

pException - the exception of the process

Throws:

Exception

searchForCmd

public String searchForCmd(String pCmd,
                           String pPath)
                    throws IOException,
                           FileNotFoundException

Query the per object search path.

Parameters:

pCmd - the command to search for

pPath - the search path

Throws:

IOException

FileNotFoundException