net.kuujo.vertigo.component

Interface ModuleConfig

All Superinterfaces:

ComponentConfig<ModuleConfig>, Config<ModuleConfig>, JsonSerializable

All Known Implementing Classes:

DefaultModuleConfig

public interface ModuleConfig
extends ComponentConfig<ModuleConfig>

Module 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	MODULE_NAME module is a string indicating the 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

Method Summary

Methods

Modifier and Type	Method and Description
String	getModule() Gets the module name.
ModuleConfig	setModule(String moduleName) Sets the module name.

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

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

Field Detail

MODULE_NAME

static final String MODULE_NAME

module is a string indicating the module name. This field is required for all module components.

See Also:

Constant Field Values

Method Detail

setModule

ModuleConfig setModule(String moduleName)

Sets the module name.

Parameters:

moduleName - The module name.

Returns:

The module configuration.

Throws:

IllegalArgumentException - If the module name is not a valid module identifier.

getModule

String getModule()

Gets the module name.

Returns:

The module name.