org.springframework.xd.module

Class ModuleDescriptor

java.lang.Object

org.springframework.xd.module.ModuleDescriptor

All Implemented Interfaces:

java.lang.Comparable<ModuleDescriptor>

public class ModuleDescriptor
extends java.lang.Object
implements java.lang.Comparable<ModuleDescriptor>

Representation of a module in the context of a defined stream or job.

Author:

Mark Fisher, Gary Russell, Luke Taylor, Ilayaperumal Gopinathan, Patrick Peralta

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleDescriptor.Builder Builder object for ModuleDescriptor.
static class	ModuleDescriptor.Key Key to be used in Map of ModuleDescriptors.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ModuleDescriptor o)
ModuleDescriptor.Key	createKey() Create a new ModuleDescriptor.Key for this ModuleDescriptor.
java.util.List<ModuleDescriptor>	getChildren() If this is a composite module, this list contains the modules that this module consists of; otherwise this list is empty.
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() Return the ModuleDefinition for this module.
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.
boolean	isComposed() Return true if this is a composed module.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

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

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

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

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.

Returns:

read-only map of module parameters

getChildren

public java.util.List<ModuleDescriptor> getChildren()

If this is a composite module, this list contains the modules that this module consists of; otherwise this list is empty.

Returns:

sub modules for this module, or empty list if this is not a composite module

getModuleDefinition

public ModuleDefinition getModuleDefinition()

Return the ModuleDefinition for this module. ModuleDefinition contains information required to load the module (i.e. classpath).

Returns:

module definition for this module descriptor

isComposed

public boolean isComposed()

Return true if this is a composed module. A composed module consists of one or more child modules.

Returns:

true if this is a composed modules

See Also:

children

createKey

public ModuleDescriptor.Key createKey()

Create a new ModuleDescriptor.Key for this ModuleDescriptor.

Returns:

new Key

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(ModuleDescriptor o)

Specified by:

compareTo in interface java.lang.Comparable<ModuleDescriptor>