Class AnnotationBuilder

java.lang.Object

io.nosqlbench.nb.api.annotations.AnnotationBuilder

All Implemented Interfaces:

AnnotationBuilderFacets.All, AnnotationBuilderFacets.WantsInterval, AnnotationBuilderFacets.WantsLabeledElement, AnnotationBuilderFacets.WantsLayer, AnnotationBuilderFacets.WantsMoreDetailsOrBuild

public class AnnotationBuilder
extends Object
implements AnnotationBuilderFacets.All

Constructor Summary

Constructors

Constructor	Description
AnnotationBuilder()

Method Summary

Modifier and Type	Method	Description
AnnotationBuilderFacets.WantsMoreDetailsOrBuild	addDetail(String name, String value)
AnnotationBuilder	at(long at)	Specify the instant of the annotated event.
Annotation	build()
AnnotationBuilderFacets.WantsInterval	element(NBLabeledElement element)	The session is the global name of a NoSQLBench process which run a scenario.
AnnotationBuilder	interval(long start, long end)	An interval annotation spans the time between two instants.
AnnotationBuilder	layer(Layer layer)
AnnotationBuilder	now()	Use the current UTC time as the annotation instant.

Methods inherited from class java.lang.Object

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

Constructor Details

AnnotationBuilder

public AnnotationBuilder()

Method Details

layer

public AnnotationBuilder layer(Layer layer)

Specified by:

layer in interface AnnotationBuilderFacets.WantsLayer

interval

public AnnotationBuilder interval(long start,
 long end)

Description copied from interface: AnnotationBuilderFacets.WantsInterval

An interval annotation spans the time between two instants.

Specified by:

interval in interface AnnotationBuilderFacets.WantsInterval

now

public AnnotationBuilder now()

Description copied from interface: AnnotationBuilderFacets.WantsInterval

Use the current UTC time as the annotation instant.

Specified by:

now in interface AnnotationBuilderFacets.WantsInterval

at

public AnnotationBuilder at(long at)

Description copied from interface: AnnotationBuilderFacets.WantsInterval

Specify the instant of the annotated event.

Specified by:

at in interface AnnotationBuilderFacets.WantsInterval

Parameters:

at -

addDetail

public AnnotationBuilderFacets.WantsMoreDetailsOrBuild addDetail(String name,
 String value)

Specified by:

addDetail in interface AnnotationBuilderFacets.WantsMoreDetailsOrBuild

build

public Annotation build()

Specified by:

build in interface AnnotationBuilderFacets.WantsMoreDetailsOrBuild

element

public AnnotationBuilderFacets.WantsInterval element(NBLabeledElement element)

Description copied from interface: AnnotationBuilderFacets.WantsLabeledElement

The session is the global name of a NoSQLBench process which run a scenario. It is required.

Specified by:

element in interface AnnotationBuilderFacets.WantsLabeledElement