ExplicitProcessParameters.Builder (External Execution Base API)

java.lang.Object
- org.netbeans.api.extexecution.base.ExplicitProcessParameters.Builder

Enclosing class:

ExplicitProcessParameters
```
public static final class ExplicitProcessParameters.Builder
extends Object
```
Builds the ExplicitProcessParameters instance. The builder initially:
- appends launcher arguments
- replaces (normal) arguments
and the mode can be overridden for each group.

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExplicitProcessParameters.Builder`	`arg(String a)` Appends a single argument.
`ExplicitProcessParameters.Builder`	`args(List<String> args)` Appends arguments in the list.
`ExplicitProcessParameters.Builder`	`args(String... args)` Appends arguments in the list.
`ExplicitProcessParameters`	`build()` Produces the `ExplicitProcessParameters` instruction.
`ExplicitProcessParameters.Builder`	`combine(ExplicitProcessParameters p)` Apply `ExplicitProcessParameters` on top of this Builder's state.
`ExplicitProcessParameters.Builder`	`environmentVariable(String name, String value)` Provide an additional environment variable for the process.
`ExplicitProcessParameters.Builder`	`environmentVariables(Map<String,String> env)` Provide additional environment variables for the process.
`ExplicitProcessParameters.Builder`	`launcherArg(String a)` Appends a single launcher argument.
`ExplicitProcessParameters.Builder`	`launcherArgs(List<String> args)` Appends arguments in the list.
`ExplicitProcessParameters.Builder`	`launcherArgs(String... args)` Appends arguments in the list.
`ExplicitProcessParameters.Builder`	`position(int position)` Defines a position for combining.
`ExplicitProcessParameters.Builder`	`replaceArgs(boolean replace)` Changes the combining mode for args.
`ExplicitProcessParameters.Builder`	`replaceLauncherArgs(boolean replace)` Changes the combining mode for launcher args.
`ExplicitProcessParameters.Builder`	`workingDirectory(File workingDirectory)` Sets working directory to be used for the process.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - arg
```
public ExplicitProcessParameters.Builder arg(@NullAllowed
                                             String a)
```
    Appends a single argument. null is ignored.
    
    Parameters:
    
    a - argument
    
    Returns:
    
    the builder
  - args
```
public ExplicitProcessParameters.Builder args(@NullAllowed
                                              List<String> args)
```
    Appends arguments in the list. null is ignored as well as null items in the list.
    
    Parameters:
    
    args - argument list
    
    Returns:
    
    the builder
  - args
```
public ExplicitProcessParameters.Builder args(@NullAllowed
                                              String... args)
```
    Appends arguments in the list. null is ignored as well as null items in the list.
    
    Parameters:
    
    args - argument list
    
    Returns:
    
    the builder
  - launcherArg
```
public ExplicitProcessParameters.Builder launcherArg(@NullAllowed
                                                     String a)
```
    Appends a single launcher argument. null is ignored.
    
    Parameters:
    
    a - launcher argument
    
    Returns:
    
    the builder
  - launcherArgs
```
public ExplicitProcessParameters.Builder launcherArgs(@NullAllowed
                                                      List<String> args)
```
    Appends arguments in the list. null is ignored as well as null items in the list.
    
    Parameters:
    
    args - argument list
    
    Returns:
    
    the builder
  - launcherArgs
```
public ExplicitProcessParameters.Builder launcherArgs(@NullAllowed
                                                      String... args)
```
    Appends arguments in the list. null is ignored as well as null items in the list.
    
    Parameters:
    
    args - argument list
    
    Returns:
    
    the builder
  - replaceArgs
```
public ExplicitProcessParameters.Builder replaceArgs(boolean replace)
```
    Changes the combining mode for args. Setting to true instructs that all arguments that may precede should be discarded and the arguments provided by the built ExplicitProcessParameters are the only ones passed to the process.
    
    Parameters:
    
    replace - true to replace, false to append
    
    Returns:
    
    the builder
  - replaceLauncherArgs
```
public ExplicitProcessParameters.Builder replaceLauncherArgs(boolean replace)
```
    Changes the combining mode for launcher args. Setting to true instructs that all arguments that may precede should be discarded and the launcher arguments provided by the built ExplicitProcessParameters are the only ones passed to the process.
    
    Parameters:
    
    replace - true to replace, false to append
    
    Returns:
    
    the builder
  - workingDirectory
```
public ExplicitProcessParameters.Builder workingDirectory(File workingDirectory)
```
    Sets working directory to be used for the process.
    
    Parameters:
    
    workingDirectory - the working directory
    
    Returns:
    
    the builder
    
    Since:
    
    1.20
  - environmentVariables
```
public ExplicitProcessParameters.Builder environmentVariables(Map<String,String> env)
```
    Provide additional environment variables for the process. Values of existing environment variables are overridden. null values are interpreted as removal of the respective variables from the environment.
    
    Parameters:
    
    env - a map of additional environment variables
    
    Returns:
    
    the builder
    
    Since:
    
    1.20
  - environmentVariable
```
public ExplicitProcessParameters.Builder environmentVariable(String name,
                                                             String value)
```
    Provide an additional environment variable for the process. If the variable already exists, it's overridden with the new value.
    
    Parameters:
    
    name - name of the environment variable
    
    value - value of the environment variable, or null in which case an existing variable is to be removed.
    
    Returns:
    
    the builder
    
    Since:
    
    1.20
  - position
```
public ExplicitProcessParameters.Builder position(int position)
```
    Defines a position for combining. The default rank is 0. When used in a collection in ExplicitProcessParameters.buildExplicitParameters(java.util.Collection), instances are sorted by their position, in ascending order (lowest first).
    
    Parameters:
    
    position - rank of the instruction
    
    Returns:
    
    the builder
  - combine
```
public ExplicitProcessParameters.Builder combine(@NullAllowed
                                                 ExplicitProcessParameters p)
```
    Apply ExplicitProcessParameters on top of this Builder's state. It will merge in the passed instruction as described in ExplicitProcessParameters.buildExplicitParameters(java.util.Collection).
    
    Parameters:
    
    p - the instruction to combine
    
    Returns:
    
    the modified builder
  - build
```
public ExplicitProcessParameters build()
```
    Produces the ExplicitProcessParameters instruction.
    
    Returns:
    
    the ExplicitProcessParameters instance.

Class ExplicitProcessParameters.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

arg

args

args

launcherArg

launcherArgs

launcherArgs

replaceArgs

replaceLauncherArgs

workingDirectory

environmentVariables

environmentVariable

position

combine

build