improve span explanations

This commit is contained in:
Jonathan Shook
2023-02-22 15:58:56 -06:00
parent 100194cd97
commit 62a2a6ee18

View File

@@ -19,7 +19,7 @@ package io.nosqlbench.engine.api.templating;
/**
* The type of a parsed template depends on the structure of the bindings provided.
*/
public enum BindType {
public enum ParsedSpanType {
/**
* A literal template is one which has no bindings that need to be provided to render a specific statement.
@@ -32,7 +32,7 @@ public enum BindType {
* 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 {@link Object#toString()}}
* Callers which use rawbind templates where Strings are needed should convert them with {@link Object#toString()}
* Example: <em>{@code {myvalue}}</em>
*/
bindref,
@@ -40,6 +40,7 @@ public enum BindType {
/**
* 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: <em>{@code Four {timeunit1} and several {timeunit2} ago}</em>
*/
concat