NbProcessDescriptor (Execution API)

java.lang.Object
- org.openide.execution.NbProcessDescriptor

All Implemented Interfaces:

java.io.Serializable
```
public final class NbProcessDescriptor
extends java.lang.Object
implements java.io.Serializable
```
Encapsulates start information for a process. It allows the user to specify the process name to execute and arguments to provide. The progammer then uses method exec to start the process and can pass additional format that will be applied to arguments.
This allows to define arguments in format -user {USER_NAME} -do {ACTION} and then use MapFormat with defined values for USER_NAME and ACTION that will be substitued by into the arguments.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`NbProcessDescriptor(java.lang.String processName, java.lang.String arguments)`	Create a new descriptor for the specified process, classpath switch, and classpath.
`NbProcessDescriptor(java.lang.String processName, java.lang.String arguments, java.lang.String info)`	Create a new descriptor for the specified process, classpath switch, and classpath.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object o)`
`java.lang.Process`	`exec()`	Executes the process with arguments provided in constructor.
`java.lang.Process`	`exec(java.text.Format format)`	Executes the process with arguments and processName formatted by the provided format.
`java.lang.Process`	`exec(java.text.Format format, java.lang.String[] envp)`	Executes the process with arguments and processNme formatted by the provided format.
`java.lang.Process`	`exec(java.text.Format format, java.lang.String[] envp, boolean appendEnv, java.io.File cwd)`	Executes the process with arguments, processName and envp formatted by the provided format.
`java.lang.Process`	`exec(java.text.Format format, java.lang.String[] envp, java.io.File cwd)`	Executes the process with arguments formatted by the provided format.
`java.lang.String`	`getArguments()`	Getter the execution arguments of the process.
`java.lang.String`	`getInfo()`	Getter for the human readable info about the arguments.
`java.lang.String`	`getProcessName()`	Get the name of the executable to run.
`int`	`hashCode()`

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

- Constructor Detail
  - NbProcessDescriptor
```
public NbProcessDescriptor(java.lang.String processName,
                           java.lang.String arguments)
```
    Create a new descriptor for the specified process, classpath switch, and classpath.
    
    Parameters:
    
    processName - the name of the executable to run
    
    arguments - string for formating of arguments (may be quoted)
  - NbProcessDescriptor
```
public NbProcessDescriptor(java.lang.String processName,
                           java.lang.String arguments,
                           java.lang.String info)
```
    Create a new descriptor for the specified process, classpath switch, and classpath.
    
    Parameters:
    
    processName - the name of the executable to run
    
    arguments - string for formating of arguments (may be quoted)
    
    info - info how to format the arguments (human-readable string)
- Method Detail
  - getProcessName
```
public java.lang.String getProcessName()
```
    Get the name of the executable to run.
    
    Returns:
    
    the name
  - getArguments
```
public java.lang.String getArguments()
```
    Getter the execution arguments of the process.
    
    Returns:
    
    the switch that the executable uses for passing the classpath as its command-line parameter
  - getInfo
```
public java.lang.String getInfo()
```
    Getter for the human readable info about the arguments.
    
    Returns:
    
    the info string or null
  - exec
```
public java.lang.Process exec(java.text.Format format,
                              java.lang.String[] envp,
                              java.io.File cwd)
                       throws java.io.IOException
```
    Executes the process with arguments formatted by the provided format. Also the envp properties are passed to the executed process, and a working directory may be supplied.
    
    Parameters:
    
    format - format to be applied to arguments, process and envp supplied by user. It can be null if no formatting should be done.
    
    envp - list of properties to be applied to the process, or null to leave unspecified
    
    cwd - the working directory to use, or null if this should not be specified
    
    Returns:
    
    handle to executed process.
    
    Throws:
    
    java.io.IOException - if the start of the process fails, or if setting the working directory is not supported
  - exec
```
public java.lang.Process exec(java.text.Format format,
                              java.lang.String[] envp,
                              boolean appendEnv,
                              java.io.File cwd)
                       throws java.io.IOException
```
    Executes the process with arguments, processName and envp formatted by the provided format. Also the envp properties are passed to the executed process, and a working directory may be supplied. Optionally the environment variables of the NetBeans JVM may be appended to (replaced when there is overlap) instead of specifying all of the environment variables from scratch. This requires the NetBeans core to translate environment variables to system properties prefixed by Env- in order to work correctly.
    
    Parameters:
    
    format - format to be applied to arguments, process and envp supplied by user. It can be null if no formatting should be done.
    
    envp - list of properties to be applied to the process, or null to leave unspecified
    
    appendEnv - if true and envp is not null, append or replace JVM's environment
    
    cwd - the working directory to use, or null if this should not be specified
    
    Returns:
    
    handle to executed process.
    
    Throws:
    
    java.io.IOException - if the start of the process fails, or if setting the working directory is not supported
    
    Since:
    
    1.15
  - exec
```
public java.lang.Process exec(java.text.Format format,
                              java.lang.String[] envp)
                       throws java.io.IOException
```
    Executes the process with arguments and processNme formatted by the provided format. Also the envp properties are passed to the executed process.
    
    Parameters:
    
    format - format to be aplied to arguments, process and envp suplied by user. It can be null if no formatting should be done.
    
    envp - list of properties to be applied to the process, or null to leave unspecified
    
    Returns:
    
    handle to executed process.
    
    Throws:
    
    java.io.IOException - if the start of the process fails
  - exec
```
public java.lang.Process exec(java.text.Format format)
                       throws java.io.IOException
```
    Executes the process with arguments and processName formatted by the provided format.
    
    Parameters:
    
    format - format to be aplied to arguments and process. It can be null if no formatting should be done.
    
    Returns:
    
    handle to executed process.
    
    Throws:
    
    java.io.IOException - if the start of the process fails
  - exec
```
public java.lang.Process exec()
                       throws java.io.IOException
```
    Executes the process with arguments provided in constructor.
    
    Returns:
    
    handle to executed process.
    
    Throws:
    
    java.io.IOException - if the start of the process fails
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object

Class NbProcessDescriptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NbProcessDescriptor

NbProcessDescriptor

Method Detail

getProcessName

getArguments

getInfo

exec

exec

exec

exec

exec

hashCode

equals