net.kuujo.vertigo.component.impl

Class DefaultModuleConfig

java.lang.Object

net.kuujo.vertigo.component.impl.DefaultModuleConfig

All Implemented Interfaces:

ComponentConfig<ModuleConfig>, ModuleConfig, Config<ModuleConfig>, JsonSerializable

public class DefaultModuleConfig
extends Object
implements ModuleConfig

Default module 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.ModuleConfig

MODULE_NAME

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
DefaultModuleConfig()
DefaultModuleConfig(String name, String moduleName, NetworkConfig network)

Method Summary

Methods

Modifier and Type	Method and Description
ModuleConfig	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	getModule() Gets the module name.
String	getName() Returns the component name.
ComponentConfig.Type	getType() Returns the component type.
ModuleConfig	setConfig(org.vertx.java.core.json.JsonObject config) Sets the component configuration.
ModuleConfig	setGroup(String group) Sets the component deployment group.
ModuleConfig	setInstances(int instances) Sets the number of component instances to deploy within the network.
ModuleConfig	setModule(String moduleName) Sets the module name.
ModuleConfig	setName(String name) Sets the component name.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultModuleConfig

public DefaultModuleConfig()

DefaultModuleConfig

public DefaultModuleConfig(String name,
                   String moduleName,
                   NetworkConfig network)

Method Detail

getType

public ComponentConfig.Type getType()

Description copied from interface: ComponentConfig

Returns the component type.

Specified by:

getType in interface ComponentConfig<ModuleConfig>

Returns:

The component type.

getName

public String getName()

Description copied from interface: ComponentConfig

Returns the component name.

Specified by:

getName in interface ComponentConfig<ModuleConfig>

Returns:

The component name.

setName

public ModuleConfig setName(String name)

Description copied from interface: ComponentConfig

Sets the component name.

Specified by:

setName in interface ComponentConfig<ModuleConfig>

Parameters:

name - The component name.

Returns:

The component configuration.

getConfig

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

Description copied from interface: ComponentConfig

Returns the component configuration.

Specified by:

getConfig in interface ComponentConfig<ModuleConfig>

Returns:

The component configuration.

setConfig

public ModuleConfig 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<ModuleConfig>

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<ModuleConfig>

Returns:

The number of component instances.

setInstances

public ModuleConfig 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<ModuleConfig>

Parameters:

instances - The number of component instances.

Returns:

The component configuration.

setGroup

public ModuleConfig setGroup(String group)

Description copied from interface: ComponentConfig

Sets the component deployment group.

Specified by:

setGroup in interface ComponentConfig<ModuleConfig>

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<ModuleConfig>

Returns:

The component deployment group.

addHook

public ModuleConfig addHook(ComponentHook hook)

Description copied from interface: ComponentConfig

Adds a hook to the component.

Specified by:

addHook in interface ComponentConfig<ModuleConfig>

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<ModuleConfig>

Returns:

A list of component hooks.

setModule

public ModuleConfig setModule(String moduleName)

Description copied from interface: ModuleConfig

Sets the module name.

Specified by:

setModule in interface ModuleConfig

Parameters:

moduleName - The module name.

Returns:

The module configuration.

getModule

public String getModule()

Description copied from interface: ModuleConfig

Gets the module name.

Specified by:

getModule in interface ModuleConfig

Returns:

The module name.