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

public Class VertxBuilder

extends Object
Class Inheritance
Imports
io.vertx.core.*, io.vertx.core.impl.transports.EpollTransport, .JDKTransport, .KQueueTransport, io.vertx.core.spi.file.FileResolver, io.vertx.core.file.impl.FileResolverImpl, io.vertx.core.impl.logging.Logger, .LoggerFactory, io.vertx.core.json.JsonObject, io.vertx.core.metrics.MetricsOptions, io.vertx.core.spi.transport.Transport, io.vertx.core.spi.ExecutorServiceFactory, .VertxMetricsFactory, .VertxServiceProvider, .VertxThreadFactory, .VertxTracerFactory, io.vertx.core.spi.cluster.ClusterManager, .NodeSelector, io.vertx.core.spi.cluster.impl.DefaultNodeSelector, io.vertx.core.spi.metrics.VertxMetrics, io.vertx.core.spi.tracing.VertxTracer, io.vertx.core.tracing.TracingOptions, java.util.ArrayList, .Collection, .Iterator
Vertx builder for creating vertx instances with SPI overrides.
Author
Julien Viet

Field Summary

Modifier and TypeField and Description
private ClusterManager
clusterManager

private NodeSelector
clusterNodeSelector

private JsonObject
config

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

private FileResolver
fileResolver

private static final Logger
log

private VertxMetrics
metrics

private VertxOptions
options

private VertxThreadFactory
threadFactory

private VertxTracer<I, O>
tracer

private Transport
transport

Constructor Summary

AccessConstructor and Description
public
VertxBuilder(JsonObject config)
References Deprecated JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

public
VertxBuilder(VertxOptions options)

public
VertxBuilder()

Method Summary

Modifier and TypeMethod and Description
private void
checkBeforeInstantiating()

private void
checkMetrics()

private void
checkTracing()

public void
clusteredVertx(Handler<AsyncResult<Vertx>> handler)

Build and return the clustered vertx instance

public ClusterManager

Returns:

the cluster manager to use
clusterManager()

public VertxBuilder

Returns:

this builder instance
clusterManager(ClusterManager
the cluster manager
clusterManager)

Set the cluster manager to use.

public NodeSelector

Returns:

the node selector to use
clusterNodeSelector()

public VertxBuilder

Returns:

this builder instance
clusterNodeSelector(NodeSelector
the selector
selector)

Set the cluster node selector to use.

public JsonObject

Returns:

the optional config when instantiated from the command line or null
config()
References Deprecated JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

public ExecutorServiceFactory

Returns:

the ExecutorServiceFactory to use
executorServiceFactory()

public VertxBuilder

Returns:

this builder instance
executorServiceFactory(ExecutorServiceFactory
the factory
factory)

Set the ExecutorServiceFactory instance to use.

public FileResolver

Returns:

the FileResolver instance to use
fileResolver()

public VertxBuilder

Returns:

this builder instance
fileResolver(FileResolver
the file resolver
resolver)

Set the FileResolver instance to use.

public Transport

Returns:

the transport to use
findTransport()

public VertxBuilder

Returns:

this builder instance
findTransport(Transport
the transport
transport)

Set the transport to for building Vertx.

pack-priv static Transport
findTransport(boolean preferNative)

public VertxBuilder

Returns:

this builder instance
init()

Initialize the service providers.

private static void
initClusterManager(VertxOptions options, Collection<VertxServiceProvider> providers)

private void
initExecutorServiceFactory()

private void
initFileResolver()

private static void
initMetrics(VertxOptions options, Collection<VertxServiceProvider> providers)

private void
initProviders(Collection<VertxServiceProvider> providers)

private void
initThreadFactory()

private static void
initTracing(VertxOptions options, Collection<VertxServiceProvider> providers)

private void
initTransport()

public VertxMetrics

Returns:

the metrics instance to use
metrics()

public VertxBuilder

Returns:

this builder instance
metrics(VertxMetrics
the metrics
metrics)

Set the metrics instance to use.

public static Transport
nativeTransport()

The native transport, it may be null or failed.

public VertxOptions

Returns:

the vertx options
options()

public VertxThreadFactory

Returns:

the VertxThreadFactory to use
threadFactory()

public VertxBuilder

Returns:

this builder instance
threadFactory(VertxThreadFactory
the metrics
factory)

Set the VertxThreadFactory instance to use.

public VertxTracer<I, O>

Returns:

the tracer instance to use
tracer()

public VertxBuilder

Returns:

this builder instance
tracer(VertxTracer<I, O>
the tracer
tracer)

Set the tracer to use.

public Vertx
vertx()

Build and return the vertx instance

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

clusterManagerback to summary
private ClusterManager clusterManager
clusterNodeSelectorback to summary
private NodeSelector clusterNodeSelector
configback to summary
private JsonObject config

References Deprecated

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

See corresponding docs for further information.

executorServiceFactoryback to summary
private ExecutorServiceFactory executorServiceFactory
fileResolverback to summary
private FileResolver fileResolver
logback to summary
private static final Logger log
metricsback to summary
private VertxMetrics metrics
optionsback to summary
private VertxOptions options
threadFactoryback to summary
private VertxThreadFactory threadFactory
tracerback to summary
private VertxTracer<I, O> tracer
transportback to summary
private Transport transport

Constructor Detail

VertxBuilderback to summary
public VertxBuilder(JsonObject config)

References Deprecated

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

See corresponding docs for further information.

VertxBuilderback to summary
public VertxBuilder(VertxOptions options)
VertxBuilderback to summary
public VertxBuilder()

Method Detail

checkBeforeInstantiatingback to summary
private void checkBeforeInstantiating()
checkMetricsback to summary
private void checkMetrics()
checkTracingback to summary
private void checkTracing()
clusteredVertxback to summary
public void clusteredVertx(Handler<AsyncResult<Vertx>> handler)

Build and return the clustered vertx instance

clusterManagerback to summary
public ClusterManager clusterManager()
Returns:ClusterManager

the cluster manager to use

clusterManagerback to summary
public VertxBuilder clusterManager(ClusterManager clusterManager)

Set the cluster manager to use.

Parameters
clusterManager:ClusterManager

the cluster manager

Returns:VertxBuilder

this builder instance

clusterNodeSelectorback to summary
public NodeSelector clusterNodeSelector()
Returns:NodeSelector

the node selector to use

clusterNodeSelectorback to summary
public VertxBuilder clusterNodeSelector(NodeSelector selector)

Set the cluster node selector to use.

Parameters
selector:NodeSelector

the selector

Returns:VertxBuilder

this builder instance

configback to summary
public JsonObject config()

References Deprecated

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

See corresponding docs for further information.

Returns:JsonObject

the optional config when instantiated from the command line or null

executorServiceFactoryback to summary
public ExecutorServiceFactory executorServiceFactory()
Returns:ExecutorServiceFactory

the ExecutorServiceFactory to use

executorServiceFactoryback to summary
public VertxBuilder executorServiceFactory(ExecutorServiceFactory factory)

Set the ExecutorServiceFactory instance to use.

Parameters
factory:ExecutorServiceFactory

the factory

Returns:VertxBuilder

this builder instance

fileResolverback to summary
public FileResolver fileResolver()
Returns:FileResolver

the FileResolver instance to use

fileResolverback to summary
public VertxBuilder fileResolver(FileResolver resolver)

Set the FileResolver instance to use.

Parameters
resolver:FileResolver

the file resolver

Returns:VertxBuilder

this builder instance

findTransportback to summary
public Transport findTransport()
Returns:Transport

the transport to use

findTransportback to summary
public VertxBuilder findTransport(Transport transport)

Set the transport to for building Vertx.

Parameters
transport:Transport

the transport

Returns:VertxBuilder

this builder instance

findTransportback to summary
pack-priv static Transport findTransport(boolean preferNative)
initback to summary
public VertxBuilder init()

Initialize the service providers.

Returns:VertxBuilder

this builder instance

initClusterManagerback to summary
private static void initClusterManager(VertxOptions options, Collection<VertxServiceProvider> providers)
initExecutorServiceFactoryback to summary
private void initExecutorServiceFactory()
initFileResolverback to summary
private void initFileResolver()
initMetricsback to summary
private static void initMetrics(VertxOptions options, Collection<VertxServiceProvider> providers)
initProvidersback to summary
private void initProviders(Collection<VertxServiceProvider> providers)
initThreadFactoryback to summary
private void initThreadFactory()
initTracingback to summary
private static void initTracing(VertxOptions options, Collection<VertxServiceProvider> providers)
initTransportback to summary
private void initTransport()
metricsback to summary
public VertxMetrics metrics()
Returns:VertxMetrics

the metrics instance to use

metricsback to summary
public VertxBuilder metrics(VertxMetrics metrics)

Set the metrics instance to use.

Parameters
metrics:VertxMetrics

the metrics

Returns:VertxBuilder

this builder instance

nativeTransportback to summary
public static Transport nativeTransport()

The native transport, it may be null or failed.

optionsback to summary
public VertxOptions options()
Returns:VertxOptions

the vertx options

threadFactoryback to summary
public VertxThreadFactory threadFactory()
Returns:VertxThreadFactory

the VertxThreadFactory to use

threadFactoryback to summary
public VertxBuilder threadFactory(VertxThreadFactory factory)

Set the VertxThreadFactory instance to use.

Parameters
factory:VertxThreadFactory

the metrics

Returns:VertxBuilder

this builder instance

tracerback to summary
public VertxTracer<I, O> tracer()
Returns:VertxTracer<I, O>

the tracer instance to use

tracerback to summary
public VertxBuilder tracer(VertxTracer<I, O> tracer)

Set the tracer to use.

Parameters
tracer:VertxTracer<I, O>

the tracer

Returns:VertxBuilder

this builder instance

vertxback to summary
public Vertx vertx()

Build and return the vertx instance