Enum Class OpTemplateFormat

java.lang.Object

java.lang.Enum<OpTemplateFormat>

io.nosqlbench.adapters.api.activityconfig.yaml.OpTemplateFormat

All Implemented Interfaces:

Serializable, Comparable<OpTemplateFormat>, Constable

public enum OpTemplateFormat
extends Enum<OpTemplateFormat>

The formats which are recognized as source data for the workload. Any serialization may be supported which can be converted from a character string to an RawOpsDocList structure. Those which are derived from paths may be determined by their filename extension. Others, which are provided from internal NoSQLBench sources, may only be invoked explicitly.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
inline	The source is inline, meaning ParamsParser format.
json	The source is in JSON format
jsonnet	The source is in jsonnet format, suitable for pre-processing with context data
stmt	The source is in single-statement form, meaning that it is known to be the value of the 'stmt' field of an op template.
yaml	The source is in YAML format

Method Summary

Modifier and Type	Method	Description
static OpTemplateFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpTemplateFormat	valueOfPath(Path path)
static OpTemplateFormat	valueOfURI(URI uri)
static OpTemplateFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

yaml

public static final OpTemplateFormat yaml

The source is in YAML format

json

public static final OpTemplateFormat json

The source is in JSON format

jsonnet

public static final OpTemplateFormat jsonnet

The source is in jsonnet format, suitable for pre-processing with context data

inline

public static final OpTemplateFormat inline

The source is inline, meaning ParamsParser format. This is similar to the stmt format except that it is parsed for internal op structure. This format is not detectable by source path, and thus can only be used when provided directly from the caller.

stmt

public static final OpTemplateFormat stmt

The source is in single-statement form, meaning that it is known to be the value of the 'stmt' field of an op template. This format is not detectable by source path, and thus can only be used when provided directly from the caller.

Method Details

values

public static OpTemplateFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OpTemplateFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

valueOfURI

public static OpTemplateFormat valueOfURI(URI uri)

valueOfPath

public static OpTemplateFormat valueOfPath(Path path)