org.springframework.xd.module

Class ModuleDescriptor.Builder

java.lang.Object

org.springframework.xd.module.ModuleDescriptor.Builder

Enclosing class:

ModuleDescriptor

public static class ModuleDescriptor.Builder
extends java.lang.Object

Builder object for ModuleDescriptor. This object is mutable to allow for flexibility in specifying module type/fields/parameters during parsing.

Constructor Summary

Constructors

Constructor and Description
ModuleDescriptor.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
ModuleDescriptor.Builder	addChildren(java.util.List<ModuleDescriptor> children) Add the list of children to the list of sub modules.
ModuleDescriptor.Builder	addParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Add the contents of the provided map to the map of module parameters.
ModuleDescriptor	build() Return a new instance of ModuleDescriptor.
static ModuleDescriptor.Builder	fromModuleDescriptor(ModuleDescriptor descriptor) Create a Builder object pre-populated with the configuration for the provided ModuleDescriptor.
java.lang.String	getGroup() Return name of deployable unit this module instance belongs to (such as a stream or job).
int	getIndex() Return position in stream/job definition relative to the other modules in the definition.
ModuleDefinition	getModuleDefinition()
java.lang.String	getModuleLabel() Return symbolic name of a module.
java.lang.String	getModuleName() Return name of module.
java.util.Map<java.lang.String,java.lang.String>	getParameters() Return parameters for module.
java.lang.String	getSinkChannelName() Return name of sink channel, if defined by the stream/job definition.
java.lang.String	getSourceChannelName() Return name of source channel, if defined by the stream/job definition.
ModuleType	getType() Return the module type.
ModuleDescriptor.Builder	setGroup(java.lang.String group) Set the module group.
ModuleDescriptor.Builder	setIndex(int index) Set the module index.
ModuleDescriptor.Builder	setModuleDefinition(ModuleDefinition moduleDefinition)
ModuleDescriptor.Builder	setModuleLabel(java.lang.String moduleLabel) Set the module label.
ModuleDescriptor.Builder	setModuleName(java.lang.String moduleName) Set the module name.
ModuleDescriptor.Builder	setParameter(java.lang.String name, java.lang.String value) Set a module parameter.
ModuleDescriptor.Builder	setSinkChannelName(java.lang.String sinkChannelName) Set the module sink channel name.
ModuleDescriptor.Builder	setSourceChannelName(java.lang.String sourceChannelName) Set the module source channel name.
ModuleDescriptor.Builder	setType(ModuleType type) Set the module type.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleDescriptor.Builder

public ModuleDescriptor.Builder()

Method Detail

setModuleName

public ModuleDescriptor.Builder setModuleName(java.lang.String moduleName)

Set the module name.

Parameters:

moduleName - name of module

Returns:

this builder object

See Also:

ModuleDescriptor.getModuleName()

setModuleLabel

public ModuleDescriptor.Builder setModuleLabel(java.lang.String moduleLabel)

Set the module label.

Parameters:

moduleLabel - name of module label

Returns:

this builder object

See Also:

ModuleDescriptor.moduleLabel

setGroup

public ModuleDescriptor.Builder setGroup(java.lang.String group)

Set the module group.

Parameters:

group - name of module group

Returns:

this builder object

See Also:

ModuleDescriptor.group

setSourceChannelName

public ModuleDescriptor.Builder setSourceChannelName(java.lang.String sourceChannelName)

Set the module source channel name.

Parameters:

sourceChannelName - name of source channel; may be null

Returns:

this builder object

See Also:

ModuleDescriptor.sourceChannelName

setSinkChannelName

public ModuleDescriptor.Builder setSinkChannelName(java.lang.String sinkChannelName)

Set the module sink channel name.

Parameters:

sinkChannelName - name of sink channel; may be null

Returns:

this builder object

See Also:

ModuleDescriptor.sinkChannelName

setIndex

public ModuleDescriptor.Builder setIndex(int index)

Set the module index.

Parameters:

index - position of module in stream/job definition

Returns:

this builder object

See Also:

ModuleDescriptor.index

setType

public ModuleDescriptor.Builder setType(ModuleType type)

Set the module type.

Parameters:

type - module type

Returns:

this builder object

See Also:

ModuleDescriptor.getType()

addChildren

public ModuleDescriptor.Builder addChildren(java.util.List<ModuleDescriptor> children)

Add the list of children to the list of sub modules. This only applies if this builder is for a composite module.

Parameters:

children - sub modules

Returns:

this builder object

See Also:

ModuleDescriptor.children

setParameter

public ModuleDescriptor.Builder setParameter(java.lang.String name,
                                    java.lang.String value)

Set a module parameter.

Parameters:

name - parameter name

value - parameter value

Returns:

this builder object

See Also:

ModuleDescriptor.parameters

addParameters

public ModuleDescriptor.Builder addParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Add the contents of the provided map to the map of module parameters.

Parameters:

parameters - module parameters

Returns:

this builder object

See Also:

ModuleDescriptor.parameters

getModuleName

public java.lang.String getModuleName()

Return name of module. Typically this module is present under $XD_HOME/modules/[module type].

Returns:

module name

getModuleLabel

public java.lang.String getModuleLabel()

Return symbolic name of a module. This may be explicitly specified in the DSL string, which is required if the stream contains another module with the same name. Otherwise, it will be the same as the module name.

Returns:

module label

getGroup

public java.lang.String getGroup()

Return name of deployable unit this module instance belongs to (such as a stream or job).

Returns:

group name

getSourceChannelName

public java.lang.String getSourceChannelName()

Return name of source channel, if defined by the stream/job definition. May be null.

Returns:

source channel name, or null if no source channel defined

getSinkChannelName

public java.lang.String getSinkChannelName()

Return name of sink channel, if defined by the stream/job definition. May be null.

Returns:

sink channel name, or null if no sink channel defined

getIndex

public int getIndex()

Return position in stream/job definition relative to the other modules in the definition. 0 indicates the first/leftmost position.

Returns:

module index

getType

public ModuleType getType()

Return the module type.

Returns:

module type

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

Return parameters for module. This is specific to the type of module - for instance an http module would include a port number as a parameter.
Note that the contents of this map are mutable.

Returns:

map of module parameters

fromModuleDescriptor

public static ModuleDescriptor.Builder fromModuleDescriptor(ModuleDescriptor descriptor)

Create a Builder object pre-populated with the configuration for the provided ModuleDescriptor.

Parameters:

descriptor - module descriptor

Returns:

pre-populated builder object

build

public ModuleDescriptor build()

Return a new instance of ModuleDescriptor.

Returns:

new instance of ModuleDescriptor

setModuleDefinition

public ModuleDescriptor.Builder setModuleDefinition(ModuleDefinition moduleDefinition)

getModuleDefinition

public ModuleDefinition getModuleDefinition()