Package dev.enola.common.exec

Record Class ProcessRequest

java.lang.Object

java.lang.Record

dev.enola.common.exec.ProcessRequest

Record Components:

directory - the working directory for the process

command - the command to execute

ctx - the ExecutionContext

mergeErrIntoOut - whether to merge the error stream into the output stream

public record ProcessRequest(Path directory, ImmutableList<String> command, Supplier<ExecutionContext> ctx, boolean mergeErrIntoOut)
extends Record

ProcessRequest describes a request for the Operating System to run a program from an image in an executable file.

This is not a Process, but what is needed to create one process (or several).

ProcessBuilder is similar to this. But that's tied to the JVM's builtin process launcher - while this may use other means to execute the command. This intentionally has no start() method, because it is passed to a ProcessLauncher to actually run it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProcessRequest.Builder

Constructor Summary

Constructors

Constructor	Description
ProcessRequest(Path directory, ImmutableList<String> command, Supplier<ExecutionContext> ctx, boolean mergeErrIntoOut)	Creates an instance of a ProcessRequest record class.

Method Summary

Modifier and Type	Method	Description
ImmutableList<String>	command()	Returns the value of the command record component.
Supplier<ExecutionContext>	ctx()	Returns the value of the ctx record component.
Path	directory()	Returns the value of the directory record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	mergeErrIntoOut()	Returns the value of the mergeErrIntoOut record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ProcessRequest

public ProcessRequest(Path directory,
 ImmutableList<String> command,
 Supplier<ExecutionContext> ctx,
 boolean mergeErrIntoOut)

Creates an instance of a ProcessRequest record class.

Parameters:

directory - the value for the directory record component

command - the value for the command record component

ctx - the value for the ctx record component

mergeErrIntoOut - the value for the mergeErrIntoOut record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

directory

public Path directory()

Returns the value of the directory record component.

Returns:

the value of the directory record component

command

public ImmutableList<String> command()

Returns the value of the command record component.

Returns:

the value of the command record component

ctx

public Supplier<ExecutionContext> ctx()

Returns the value of the ctx record component.

Returns:

the value of the ctx record component

mergeErrIntoOut

public boolean mergeErrIntoOut()

Returns the value of the mergeErrIntoOut record component.

Returns:

the value of the mergeErrIntoOut record component