net.kuujo.vertigo.component.impl

Class DefaultVerticleConfig

java.lang.Object

net.kuujo.vertigo.component.impl.DefaultVerticleConfig

All Implemented Interfaces:

ComponentConfig<VerticleConfig>, VerticleConfig, Config<VerticleConfig>, JsonSerializable

public class DefaultVerticleConfig
extends Object
implements VerticleConfig

Default verticle configuration implementation.

Author:

Jordan Halterman

Nested Class Summary

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

ComponentConfig.Type

Field Summary

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

VERTICLE_IS_MULTI_THREADED, VERTICLE_IS_WORKER, 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

Constructor Summary

Constructors

Constructor and Description
DefaultVerticleConfig()
DefaultVerticleConfig(String name, String main, NetworkConfig network)

Method Summary

Methods

Modifier and Type	Method and Description
VerticleConfig	addHook(ComponentHook hook) Adds a hook to the component.
org.vertx.java.core.json.JsonObject	getConfig() Returns the component configuration.
String	getGroup() Returns the component deployment group.
List<ComponentHook>	getHooks() Returns a list of component hooks.
int	getInstances() Returns the number of component instances to deploy within the network.
String	getMain() Gets the verticle main.
String	getName() Returns the component name.
ComponentConfig.Type	getType() Returns the component type.
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	setConfig(org.vertx.java.core.json.JsonObject config) Sets the component configuration.
VerticleConfig	setGroup(String group) Sets the component deployment group.
VerticleConfig	setInstances(int instances) Sets the number of component instances to deploy within the network.
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 class java.lang.Object

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

Constructor Detail

DefaultVerticleConfig

public DefaultVerticleConfig()

DefaultVerticleConfig

public DefaultVerticleConfig(String name,
                     String main,
                     NetworkConfig network)

Method Detail

getType

public ComponentConfig.Type getType()

Description copied from interface: ComponentConfig

Returns the component type.

Specified by:

getType in interface ComponentConfig<VerticleConfig>

Returns:

The component type.

getName

public String getName()

Description copied from interface: ComponentConfig

Returns the component name.

Specified by:

getName in interface ComponentConfig<VerticleConfig>

Returns:

The component name.

getConfig

public org.vertx.java.core.json.JsonObject getConfig()

Description copied from interface: ComponentConfig

Returns the component configuration.

Specified by:

getConfig in interface ComponentConfig<VerticleConfig>

Returns:

The component configuration.

setConfig

public VerticleConfig setConfig(org.vertx.java.core.json.JsonObject config)

Description copied from interface: ComponentConfig

Sets the component configuration.

This configuration will be passed to component implementations as the verticle or module configuration when the component is started.

Specified by:

setConfig in interface ComponentConfig<VerticleConfig>

Parameters:

config - The component configuration.

Returns:

The component configuration.

getInstances

public int getInstances()

Description copied from interface: ComponentConfig

Returns the number of component instances to deploy within the network.

Specified by:

getInstances in interface ComponentConfig<VerticleConfig>

Returns:

The number of component instances.

setInstances

public VerticleConfig setInstances(int instances)

Description copied from interface: ComponentConfig

Sets the number of component instances to deploy within the network.

Specified by:

setInstances in interface ComponentConfig<VerticleConfig>

Parameters:

instances - The number of component instances.

Returns:

The component configuration.

setGroup

public VerticleConfig setGroup(String group)

Description copied from interface: ComponentConfig

Sets the component deployment group.

Specified by:

setGroup in interface ComponentConfig<VerticleConfig>

Parameters:

group - The component deployment group.

Returns:

The component configuration.

getGroup

public String getGroup()

Description copied from interface: ComponentConfig

Returns the component deployment group.

Specified by:

getGroup in interface ComponentConfig<VerticleConfig>

Returns:

The component deployment group.

addHook

public VerticleConfig addHook(ComponentHook hook)

Description copied from interface: ComponentConfig

Adds a hook to the component.

Specified by:

addHook in interface ComponentConfig<VerticleConfig>

Parameters:

hook - The hook to add.

Returns:

The component configuration.

getHooks

public List<ComponentHook> getHooks()

Description copied from interface: ComponentConfig

Returns a list of component hooks.

Specified by:

getHooks in interface ComponentConfig<VerticleConfig>

Returns:

A list of component hooks.

setMain

public VerticleConfig setMain(String main)

Description copied from interface: VerticleConfig

Sets the verticle main.

Specified by:

setMain in interface VerticleConfig

Parameters:

main - The verticle main.

Returns:

The verticle configuration.

getMain

public String getMain()

Description copied from interface: VerticleConfig

Gets the verticle main.

Specified by:

getMain in interface VerticleConfig

Returns:

The verticle main.

setWorker

public VerticleConfig setWorker(boolean isWorker)

Description copied from interface: VerticleConfig

Sets the verticle worker option.

Specified by:

setWorker in interface VerticleConfig

Parameters:

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

Returns:

The verticle configuration.

isWorker

public boolean isWorker()

Description copied from interface: VerticleConfig

Returns a boolean indicating whether the verticle is a worker.

Specified by:

isWorker in interface VerticleConfig

Returns:

Indicates whether the verticle is a worker.

setMultiThreaded

public VerticleConfig setMultiThreaded(boolean isMultiThreaded)

Description copied from interface: VerticleConfig

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

Specified by:

setMultiThreaded in interface VerticleConfig

Parameters:

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

Returns:

The verticle configuration.

isMultiThreaded

public boolean isMultiThreaded()

Description copied from interface: VerticleConfig

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

Specified by:

isMultiThreaded in interface VerticleConfig

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.