org.safs.android.auto.lib

Class Process2

java.lang.Object

org.safs.android.auto.lib.Process2

public class Process2
extends java.lang.Object

Extends Process by wrapping one.

Constructor Summary

Constructors

Constructor and Description
Process2(java.lang.Process process) Default constructor allowing process cleanup on JVM Shutdown.
Process2(java.lang.Process process, boolean no_shutdown_hook) Alternate constructor to allow the prevention of cleanup on JVM Shutdown.

Method Summary

Modifier and Type	Method and Description
Process2	connectStderr(java.lang.Appendable sink)
Process2	connectStdin(java.io.InputStream source)
Process2	connectStdin(java.lang.Readable source)
Process2	connectStdout(java.lang.Appendable sink)
void	destroy() destroy() the underlying process IF the flag to persist beyond shutdown is not set.
Process2	discardStderr() Connects Stderr to the internal DEV_NULL sink.
Process2	discardStdout() Connects Stdout to the internal DEV_NULL sink.
int	exitValue() Returns the exit value for the subprocess.
Process2	forwardIO() Forward Process Stdin to System.in Also invokes forwardOutput
Process2	forwardOutput() Forward Process StdOut to System.out and forward StdErr to System.err.
java.lang.Process	getProcess()
java.io.InputStream	getStderr()
java.io.BufferedReader	getStderrReader()
java.io.OutputStream	getStdin()
java.io.Writer	getStdinWriter()
java.io.InputStream	getStdout()
java.io.BufferedReader	getStdoutReader()
void	removeJVMShutdownReference() Remove this process from the JVM Shutdown Hook thread.
void	setPersist(boolean doPersist) Change the persist status of this process.
Process2	waitFor() Wait/Block for the exitValue/completion from the wrapped Process.
Process2	waitFor(int secsTimeout) Wait/Block for the exitValue/completion from the wrapped Process up to the provided secsTimeout period.
Process2	waitForSuccess() Wait for exitValue (0) from the wrapped Process.
Process2	waitForSuccess(int secsTimeout) Wait for exitValue (0) from the wrapped Process within the specified timeout period.

Methods inherited from class java.lang.Object

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

Constructor Detail

Process2

public Process2(java.lang.Process process)

Default constructor allowing process cleanup on JVM Shutdown. This is the same as instancing Process2(process, false)

Parameters:

process - object to wrap

Process2

public Process2(java.lang.Process process,
                boolean no_shutdown_hook)

Alternate constructor to allow the prevention of cleanup on JVM Shutdown. Use this if you need to allow the underlying process to persist after shutdown.

Parameters:

process - object to wrap

no_shutdown_hook - -- true to persist the process beyond JVM shutdown.

See Also:

persist

Method Detail

setPersist

public void setPersist(boolean doPersist)

Change the persist status of this process. If persist is being set "true", then we will attempt to remove this process from the cache of processes that will be destroyed upon JVM Shutdown. If persist is being set "false", then we will attempt to add this process to the cache of processes that will be destroyed upon JVM Shutdown.

Parameters:

doPersist -

destroy

public void destroy()

destroy() the underlying process IF the flag to persist beyond shutdown is not set. If the flag is not set we will remove this process from the JVM shutdown hook thread and destroy it immediately.

See Also:

persist

removeJVMShutdownReference

public void removeJVMShutdownReference()

Remove this process from the JVM Shutdown Hook thread. This will only succeed if we are not already in JVM shutdown mode.

exitValue

public int exitValue()

Returns the exit value for the subprocess.

Returns:

the exit value of the subprocess represented by this Process object. By convention, the value 0 indicates normal termination.

Throws:

java.lang.IllegalThreadStateException - - if the subprocess represented by this Process object has not yet terminated.

waitFor

public Process2 waitFor()
                 throws java.lang.InterruptedException

Wait/Block for the exitValue/completion from the wrapped Process.

Returns:

this

Throws:

java.lang.InterruptedException - if thrown by the underlying process.

See Also:

Process.waitFor()

waitFor

public Process2 waitFor(int secsTimeout)
                 throws java.lang.InterruptedException

Wait/Block for the exitValue/completion from the wrapped Process up to the provided secsTimeout period.

Parameters:

secsTimeout - -- number of seconds to wait before issuing IllegalThreadStateException.

Returns:

this

Throws:

java.lang.InterruptedException - if thrown by the underlying process.

java.lang.IllegalThreadStateException - if the timeout has been reached without the process having exited.

waitForSuccess

public Process2 waitForSuccess()
                        throws java.lang.InterruptedException

Wait for exitValue (0) from the wrapped Process. If the exitValue is not 0 then the routine will throw a RuntimeException.

Returns:

this

Throws:

java.lang.InterruptedException - if thrown by the underlying process.

java.lang.RuntimeException - if the exitValue is NOT 0 (success).

See Also:

waitFor(), Process.waitFor()

waitForSuccess

public Process2 waitForSuccess(int secsTimeout)
                        throws java.lang.InterruptedException

Wait for exitValue (0) from the wrapped Process within the specified timeout period. If the exitValue is not 0 then the routine will throw a RuntimeException.

Parameters:

secsTimeout - -- number of seconds to wait before issuing an IllegalThreadStateException.

Returns:

this

Throws:

java.lang.InterruptedException - if thrown by the underlying process.

java.lang.RuntimeException - if the exitValue is NOT 0 (success).

java.lang.IllegalThreadStateException - if the timeout is reached without process termination.

See Also:

waitFor(int)

getProcess

public java.lang.Process getProcess()

getStdin

public java.io.OutputStream getStdin()

getStdinWriter

public java.io.Writer getStdinWriter()

getStdout

public java.io.InputStream getStdout()

getStdoutReader

public java.io.BufferedReader getStdoutReader()

getStderr

public java.io.InputStream getStderr()

getStderrReader

public java.io.BufferedReader getStderrReader()

connectStdin

public Process2 connectStdin(java.lang.Readable source)

connectStdin

public Process2 connectStdin(java.io.InputStream source)

connectStdout

public Process2 connectStdout(java.lang.Appendable sink)

connectStderr

public Process2 connectStderr(java.lang.Appendable sink)

discardStdout

public Process2 discardStdout()

Connects Stdout to the internal DEV_NULL sink.

Returns:

this (from connectStdout)

See Also:

connectStdout(Appendable)

discardStderr

public Process2 discardStderr()

Connects Stderr to the internal DEV_NULL sink.

Returns:

this (from connectStdout)

See Also:

connectStderr(Appendable)

forwardIO

public Process2 forwardIO()

Forward Process Stdin to System.in Also invokes forwardOutput

Returns:

this (from forwardOutput())

See Also:

forwardOutput()

forwardOutput

public Process2 forwardOutput()

Forward Process StdOut to System.out and forward StdErr to System.err. Uses connectStdout(System.out); connectStderr(System.err);

Returns:

this