net.kuujo.vertigo.component

Interface VerticleConfig

All Superinterfaces:

ComponentConfig<VerticleConfig>, Config<VerticleConfig>, JsonSerializable

All Known Implementing Classes:

DefaultVerticleConfig

public interface VerticleConfig
extends ComponentConfig<VerticleConfig>

Verticle component configuration.

Author:

Jordan Halterman

Nested Class Summary

Nested classes/interfaces inherited from interface net.kuujo.vertigo.component.ComponentConfig

ComponentConfig.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERTICLE_IS_MULTI_THREADED multi-threaded is a boolean indicating whether a worker verticle is multi-threaded.
static String	VERTICLE_IS_WORKER worker is a boolean indicating whether this verticle should be deployed as a worker verticle.
static String	VERTICLE_MAIN main is a string indicating the verticle main.

Fields inherited from interface net.kuujo.vertigo.component.ComponentConfig

COMPONENT_CONFIG, COMPONENT_GROUP, COMPONENT_HOOKS, COMPONENT_NAME, COMPONENT_NUM_INSTANCES, COMPONENT_TYPE, COMPONENT_TYPE_MODULE, COMPONENT_TYPE_VERTICLE

Method Summary

Methods

Modifier and Type	Method and Description
String	getMain() Gets the verticle main.
boolean	isMultiThreaded() Returns a boolean indicating whether the verticle is a worker and is multi-threaded.
boolean	isWorker() Returns a boolean indicating whether the verticle is a worker.
VerticleConfig	setMain(String main) Sets the verticle main.
VerticleConfig	setMultiThreaded(boolean isMultiThreaded) Sets the verticle multi-threaded option.
VerticleConfig	setWorker(boolean isWorker) Sets the verticle worker option.

Methods inherited from interface net.kuujo.vertigo.component.ComponentConfig

addHook, getConfig, getGroup, getHooks, getInstances, getName, getType, setConfig, setGroup, setInstances, setName

Field Detail

VERTICLE_MAIN

static final String VERTICLE_MAIN

main is a string indicating the verticle main. This field is required for all verticle components.

See Also:

Constant Field Values

VERTICLE_IS_WORKER

static final String VERTICLE_IS_WORKER

worker is a boolean indicating whether this verticle should be deployed as a worker verticle. Defaults to false

See Also:

Constant Field Values

VERTICLE_IS_MULTI_THREADED

static final String VERTICLE_IS_MULTI_THREADED

multi-threaded is a boolean indicating whether a worker verticle is multi-threaded. This option only applies to verticles where worker is true. Defaults to false

See Also:

Constant Field Values

Method Detail

setMain

VerticleConfig setMain(String main)

Sets the verticle main.

Parameters:

main - The verticle main.

Returns:

The verticle configuration.

getMain

String getMain()

Gets the verticle main.

Returns:

The verticle main.

setWorker

VerticleConfig setWorker(boolean isWorker)

Sets the verticle worker option.

Parameters:

isWorker - Indicates whether the verticle should be deployed as a worker.

Returns:

The verticle configuration.

isWorker

boolean isWorker()

Returns a boolean indicating whether the verticle is a worker.

Returns:

Indicates whether the verticle is a worker.

setMultiThreaded

VerticleConfig setMultiThreaded(boolean isMultiThreaded)

Sets the verticle multi-threaded option. This option only applies to worker verticles.

Parameters:

isMultiThreaded - Indicates whether the worker verticle is multi-threaded.

Returns:

The verticle configuration.

isMultiThreaded

boolean isMultiThreaded()

Returns a boolean indicating whether the verticle is a worker and is multi-threaded.

Returns:

Indicates whether the verticle is a worker and is multi-threaded. If the verticle is not a worker verticle then false will be returned.