Enum Class ParsedSpanType

java.lang.Object

java.lang.Enum<ParsedSpanType>

io.nosqlbench.engine.api.templating.ParsedSpanType

All Implemented Interfaces:

Serializable, Comparable<ParsedSpanType>, Constable

public enum ParsedSpanType
extends Enum<ParsedSpanType>

The type of a parsed template depends on the structure of the bindings provided.

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
bindref	A bindref template is one which has only a single bind point and no leading or trailing text.
concat	A string template is one which is neither a literal template nor a bindref template.
literal	A literal template is one which has no bindings that need to be provided to render a specific statement.

Method Summary

Modifier and Type	Method	Description
static ParsedSpanType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ParsedSpanType[]	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

literal

public static final ParsedSpanType literal

A literal template is one which has no bindings that need to be provided to render a specific statement. These templates are basically static values. Example: truncate testks.testtable;

bindref

public static final ParsedSpanType bindref

A bindref template is one which has only a single bind point and no leading or trailing text. It represents a single value which is to be injected, with no clear indication as to whether the value should be in string form or not. These are used when referencing objects by bind point name. Callers which use rawbind templates where Strings are needed should convert them with Object.toString() Example: {myvalue}

concat

public static final ParsedSpanType concat

A string template is one which is neither a literal template nor a bindref template. This includes any template which has any amount of literal text and any template with more than one bind point. Example: Four {timeunit1} and several {timeunit2} ago

Method Details

values

public static ParsedSpanType[] 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 ParsedSpanType 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