Package io.nosqlbench.api.annotations

Class AnnotationBuilder

java.lang.Object

io.nosqlbench.api.annotations.AnnotationBuilder

All Implemented Interfaces:

AnnotationBuilderFacets.All, AnnotationBuilderFacets.WantsInterval, AnnotationBuilderFacets.WantsLabels, AnnotationBuilderFacets.WantsLayer, AnnotationBuilderFacets.WantsMoreDetailsOrBuild, AnnotationBuilderFacets.WantsMoreLabelsOrDetails, AnnotationBuilderFacets.WantsSession

public class AnnotationBuilder
extends Object
implements AnnotationBuilderFacets.All

Constructor Summary

Constructors

Constructor	Description
AnnotationBuilder()

Method Summary

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

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

label

public AnnotationBuilder label(String name,
 String value)

Specified by:

label in interface AnnotationBuilderFacets.WantsLabels

Specified by:

label in interface AnnotationBuilderFacets.WantsMoreLabelsOrDetails

detail

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

Specified by:

detail in interface AnnotationBuilderFacets.WantsMoreDetailsOrBuild

Specified by:

detail in interface AnnotationBuilderFacets.WantsMoreLabelsOrDetails

build

public Annotation build()

Specified by:

build in interface AnnotationBuilderFacets.WantsMoreDetailsOrBuild

session

public AnnotationBuilderFacets.WantsInterval session(String session)

Description copied from interface: AnnotationBuilderFacets.WantsSession

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

Specified by:

session in interface AnnotationBuilderFacets.WantsSession