Module io.smallrye.common.process

Package io.smallrye.common.process

Interface WaitableProcessHandle

All Superinterfaces:

Comparable<ProcessHandle>, ProcessHandle

public interface WaitableProcessHandle
extends ProcessHandle

A process handle that can be waited for and whose exit value may be read.

Nested Class Summary

Nested classes/interfaces inherited from interface java.lang.ProcessHandle

ProcessHandle.Info

Method Summary

Modifier and Type	Method	Description
List<String>	arguments()	Returns the initial process arguments as an immutable list (not null).
Path	command()	Returns the initial process command (not null).
int	exitValue()	Returns the process exit value.
int	waitFor()	Wait indefinitely for the process to exit.
boolean	waitFor(long timeout, TimeUnit unit)	Wait for the process to exit for up to the given time.
default int	waitUninterruptiblyFor()	Wait indefinitely and uninterruptibly for the process to exit.
default boolean	waitUninterruptiblyFor(long timeout, TimeUnit unit)	Wait uninterruptibly for the process to exit for up to the given time.

Methods inherited from interface java.lang.ProcessHandle

children, compareTo, descendants, destroy, destroyForcibly, equals, hashCode, info, isAlive, onExit, parent, pid, supportsNormalTermination

Method Details

command

Path command()

Returns the initial process command (not null). This may differ from what ProcessHandle.Info.command() returns.

Returns:

the initial process command (not null)

arguments

List<String> arguments()

Returns the initial process arguments as an immutable list (not null). This may differ from what ProcessHandle.Info.arguments() returns.

Returns:

the initial process arguments as an immutable list (not null)

waitFor

int waitFor()
     throws InterruptedException

Wait indefinitely for the process to exit.

Returns:

the exit code of the process

Throws:

InterruptedException - if the current thread is interrupted

See Also:

• Process.waitFor()

waitUninterruptiblyFor

default int waitUninterruptiblyFor()

Wait indefinitely and uninterruptibly for the process to exit.

Returns:

the exit code of the process

See Also:

• Process.waitFor()

waitFor

boolean waitFor(long timeout,
 TimeUnit unit)
         throws InterruptedException

Wait for the process to exit for up to the given time.

Parameters:

timeout - the amount of time to wait

unit - the time unit (must not be null)

Returns:

true if the process has exited, or false if it is still running

Throws:

InterruptedException - if the current thread is interrupted

See Also:

• Process.waitFor(long,TimeUnit)

waitUninterruptiblyFor

default boolean waitUninterruptiblyFor(long timeout,
 TimeUnit unit)

Wait uninterruptibly for the process to exit for up to the given time.

Parameters:

timeout - the amount of time to wait

unit - the time unit (must not be null)

Returns:

true if the process has exited, or false if it is still running

See Also:

• Process.waitFor(long,TimeUnit)

exitValue

int exitValue()

Returns the process exit value.

Returns:

the process exit value

Throws:

IllegalThreadStateException - if the process has not exited

See Also:

• Process.exitValue()