org.springframework.xd.dirt.module.store

Class ModuleMetadata.Id

java.lang.Object

org.springframework.xd.dirt.module.store.ModuleMetadata.Id

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ModuleMetadata.Id>

Enclosing class:

ModuleMetadata

public static class ModuleMetadata.Id
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<ModuleMetadata.Id>

Identity object for instances of ModuleMetadata.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ModuleMetadata.Id(java.lang.String containerId, java.lang.String fullyQualifiedId) Construct a ModuleMetadata id.
ModuleMetadata.Id(java.lang.String containerId, java.lang.String unitName, ModuleType moduleType, java.lang.String moduleLabel, int index) Construct a ModuleMetadata id.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ModuleMetadata.Id that)
boolean	equals(java.lang.Object o)
java.lang.String	getContainerId() Return the id for the container the module instance is deployed to.
java.lang.String	getFullyQualifiedId() Return the "fully qualified" id string for the module instance this metadata object is tracking.
int	getIndex() Return the position in stream/job definition relative to other modules in the deployment unit.
java.lang.String	getModuleLabel() Return the label for the module instance this metadata object is tracking.
ModuleType	getModuleType() Return the module type for the module instance this metadata object is tracking.
java.lang.String	getUnitName() Return the deployment unit name (stream or job) for the module instance this metadata object is tracking.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModuleMetadata.Id

public ModuleMetadata.Id(java.lang.String containerId,
                 java.lang.String unitName,
                 ModuleType moduleType,
                 java.lang.String moduleLabel,
                 int index)

Construct a ModuleMetadata id.

Parameters:

containerId - id of container the module is deployed to

unitName - name of deployment unit the module instance belongs to

moduleType - type of module

moduleLabel - module label

index - index of module in deployment unit

ModuleMetadata.Id

public ModuleMetadata.Id(java.lang.String containerId,
                 java.lang.String fullyQualifiedId)

Construct a ModuleMetadata id.

Parameters:

containerId - id of container the module is deployed to

fullyQualifiedId - "fully qualified" id string for module instance

See Also:

getFullyQualifiedId()

Method Detail

getContainerId

public java.lang.String getContainerId()

Return the id for the container the module instance is deployed to.

Returns:

container id hosting the module instance

getUnitName

public java.lang.String getUnitName()

Return the deployment unit name (stream or job) for the module instance this metadata object is tracking.

Returns:

deployment unit name

getModuleType

public ModuleType getModuleType()

Return the module type for the module instance this metadata object is tracking.

Returns:

module type

getModuleLabel

public java.lang.String getModuleLabel()

Return the label for the module instance this metadata object is tracking.

Returns:

label for module

getIndex

public int getIndex()

Return the position in stream/job definition relative to other modules in the deployment unit.

Returns:

index for module

getFullyQualifiedId

public java.lang.String getFullyQualifiedId()

Return the "fully qualified" id string for the module instance this metadata object is tracking. The format for this string is "deploymentUnitName.type.label.index", for example "ticktock.sink.log.1".

Returns:

fully qualified id string

compareTo

public int compareTo(ModuleMetadata.Id that)

Specified by:

compareTo in interface java.lang.Comparable<ModuleMetadata.Id>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object