CmdParameters (Nuxeo 2021.70.4 API Documentation)

java.lang.Object
- org.nuxeo.ecm.platform.commandline.executor.api.CmdParameters

All Implemented Interfaces:

Serializable
```
public class CmdParameters
extends Object
implements Serializable
```
Wraps command parameters (String or File path, or a list of values that will be expanded as separate parameters).

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CmdParameters.ParameterValue
A parameter value holding either a single String or a list of Strings.

Constructor Summary

Constructors
Constructor	Description
`CmdParameters()`	It is recommended to use the CmdParameters instance returned by `CommandLineExecutorService.getDefaultCmdParameters()` which is initialized with a few common parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addNamedParameter(String name, File file)`
`void`	`addNamedParameter(String name, String value)`
`void`	`addNamedParameter(String name, List<String> values)`
`String`	`getParameter(String name)`
`Map<String,CmdParameters.ParameterValue>`	`getParameters()`

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

Constructor Detail
- CmdParameters
```
public CmdParameters()
```
  It is recommended to use the CmdParameters instance returned by CommandLineExecutorService.getDefaultCmdParameters() which is initialized with a few common parameters.
  
  See Also:
  
  CommandLineExecutorService.getDefaultCmdParameters()

Method Detail

addNamedParameter

public void addNamedParameter(String name,
                              String value)

addNamedParameter

public void addNamedParameter(String name,
                              File file)

addNamedParameter

public void addNamedParameter(String name,
                              List<String> values)

Since:: 7.10

getParameter

public String getParameter(String name)

Since:: 7.10

getParameters

public Map<String,CmdParameters.ParameterValue> getParameters()

Since:: 7.1