Top Description Fields Constructors Methods
io.vertx.core.tracing

public Class TracingOptions

extends Object
Class Inheritance
Annotations
@DataObject
@JsonGen
publicConverter:false
Imports
io.vertx.codegen.annotations.DataObject, io.vertx.codegen.json.annotations.JsonGen, io.vertx.core.json.JsonObject, io.vertx.core.spi.VertxTracerFactory, io.vertx.core.spi.cluster.ClusterManager

Vert.x tracing base configuration, this class can be extended by provider implementations to configure those specific implementations.
Author
Julien Viet

Field Summary

Modifier and TypeField and Description
private VertxTracerFactory
private JsonObject
json

References Deprecated JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

Constructor Summary

AccessConstructor and Description
public
TracingOptions()

Default constructor

public
TracingOptions(TracingOptions
The other TracingOptions to copy when creating this
other
)

Copy constructor

public
TracingOptions(JsonObject
the JsonObject to create it from
json
)
References Deprecated JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

Create an instance from a JsonObject

Method Summary

Modifier and TypeMethod and Description
public TracingOptions
copy()

public VertxTracerFactory

Returns:

the tracer factory
getFactory
()

Get the tracer factory to be used when tracing are enabled.

public TracingOptions

Returns:

a reference to this, so the API can be used fluently
setFactory
(VertxTracerFactory
the tracer factory
factory
)

Programmatically set the tracer factory to be used when tracing are enabled.

public JsonObject
toJson()
References Deprecated JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

factoryback to summary
private VertxTracerFactory factory
jsonback to summary
private JsonObject json

References Deprecated

JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Constructor Detail

TracingOptionsback to summary
public TracingOptions()

Default constructor

TracingOptionsback to summary
public TracingOptions(TracingOptions other)

Copy constructor

Parameters
other:TracingOptions

The other TracingOptions to copy when creating this

TracingOptionsback to summary
public TracingOptions(JsonObject json)

References Deprecated

JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Create an instance from a JsonObject

Parameters
json:JsonObject

the JsonObject to create it from

Method Detail

copyback to summary
public TracingOptions copy()
getFactoryback to summary
public VertxTracerFactory getFactory()

Get the tracer factory to be used when tracing are enabled.

If the tracer factory has been programmatically set here, then that will be used when tracing are enabled for creating the io.vertx.core.spi.tracing.VertxTracer instance.

Otherwise Vert.x attempts to locate a tracer factory implementation on the classpath.

Returns:VertxTracerFactory

the tracer factory

setFactoryback to summary
public TracingOptions setFactory(VertxTracerFactory factory)

Programmatically set the tracer factory to be used when tracing are enabled.

Normally Vert.x will look on the classpath for a tracer factory implementation, but if you want to set one programmatically you can use this method.

Parameters
factory:VertxTracerFactory

the tracer factory

Returns:TracingOptions

a reference to this, so the API can be used fluently

Annotations
@Deprecated
toJsonback to summary
public JsonObject toJson()

References Deprecated

JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override