Class Cmd

java.lang.Object

io.nosqlbench.engine.cmdstream.Cmd

public class Cmd
extends Object

Encapsulate Command parsing and structure for the NoSQLBench command line. Commands always have a name, sometimes have a list of positional arguments, and sometimes have a map of named parameters. An example of a command tha thas both would look like script test.js p1=v1

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_TARGET_CONTEXT

Constructor Summary

Constructors

Constructor	Description
Cmd(@NotNull CmdType cmdType, Map<String,CmdArg> cmdArgMap)
Cmd(@NotNull CmdType cmdType, Map<String,CmdArg> cmdArgMap, String targetContext, String stepName)
Cmd(@NotNull String cmdTypeOrName, Map<String,CmdArg> argmap)

Method Summary

Modifier and Type	Method	Description
String	asScriptText()
Cmd	forContainer(String containerName, String stepName)
Map<String,String>	getArgMap()
Map<String,CmdArg>	getArgs()
String	getArgValue(String paramName)
String	getArgValueOrNull(String paramName)
CmdType	getCmdType()
String	getStepName()
String	getTargetContext()
String	takeArgValue(String paramName)
static String	toJSONBlock(Map<String,String> map, boolean oneline)
static String	toJSONParams(String varname, Map<String,String> map, boolean oneline)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_TARGET_CONTEXT

public static final String DEFAULT_TARGET_CONTEXT

See Also:

• Constant Field Values

Constructor Details

Cmd

public Cmd(@NotNull
 @NotNull String cmdTypeOrName,
 Map<String,CmdArg> argmap)

Cmd

public Cmd(@NotNull
 @NotNull CmdType cmdType,
 Map<String,CmdArg> cmdArgMap)

Cmd

public Cmd(@NotNull
 @NotNull CmdType cmdType,
 Map<String,CmdArg> cmdArgMap,
 String targetContext,
 String stepName)

Method Details

getTargetContext

public String getTargetContext()

forContainer

public Cmd forContainer(String containerName,
 String stepName)

getArgValueOrNull

public String getArgValueOrNull(String paramName)

takeArgValue

public String takeArgValue(String paramName)

getArgValue

public String getArgValue(String paramName)

getCmdType

public CmdType getCmdType()

getArgs

public Map<String,CmdArg> getArgs()

toString

public String toString()

Overrides:

toString in class Object

asScriptText

public String asScriptText()

toJSONBlock

public static String toJSONBlock(Map<String,String> map,
 boolean oneline)

toJSONParams

public static String toJSONParams(String varname,
 Map<String,String> map,
 boolean oneline)

getArgMap

public Map<String,String> getArgMap()

getStepName

public String getStepName()