org.springframework.xd.dirt.core

Class JobDeploymentsPath

java.lang.Object

org.springframework.xd.dirt.core.JobDeploymentsPath

public class JobDeploymentsPath
extends java.lang.Object

Builder object for paths under Paths.JOB_DEPLOYMENTS. JobDeploymentsPath can be used to take a full path and split it into its elements, for example:

 JobDeploymentsPath path = new JobDeploymentsPath("/xd/deployments/jobs/my-job");
 assertEquals("my-job", path.getJobName());
 

It can also be used to build a path, for example:

 JobDeploymentsPath path = new JobDeploymentsPath().setJobName("my-job")...
 assertEquals("/deployments/jobs/my-job", path.build());
 

Note that all fields must be set prior to invoking build().

Author:

Patrick Peralta, Mark Fisher, Ilayaperumal Gopinathan

Constructor Summary

Constructors

Constructor and Description
JobDeploymentsPath() Construct a JobDeploymentsPath.
JobDeploymentsPath(java.lang.String path) Construct a JobDeploymentsPath.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	build() Build the path string using the field values.
java.lang.String	buildWithNamespace() Build the path string using the field values, including the namespace prefix.
java.lang.String	getContainer() Return the container name.
java.lang.String	getJobName() Return the job name.
java.lang.String	getModuleInstanceAsString() Return the string representation of the module instance that has the following dot limited values.
java.lang.String	getModuleLabel() Return the module label.
int	getModuleSequence() Return the module sequence.
java.lang.String	getModuleSequenceAsString() Return the module sequence as string.
java.lang.String	getModuleType() Return the module type.
JobDeploymentsPath	setContainer(java.lang.String container) Set the container name.
JobDeploymentsPath	setJobName(java.lang.String name) Set the job name.
JobDeploymentsPath	setModuleLabel(java.lang.String label) Set the module label.
JobDeploymentsPath	setModuleSequence(java.lang.String moduleSequence) Set the module sequence.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JobDeploymentsPath

public JobDeploymentsPath()

Construct a JobDeploymentsPath. Use of this constructor means that a path will be created via build() or buildWithNamespace().

JobDeploymentsPath

public JobDeploymentsPath(java.lang.String path)

Construct a JobDeploymentsPath. Use of this constructor means that an existing path will be provided and this object will be used to extract the individual elements of the path. Both full paths (including and excluding the XD namespace prefix) are supported.

Parameters:

path - job deployment path

Method Detail

getModuleInstanceAsString

public java.lang.String getModuleInstanceAsString()

Return the string representation of the module instance that has the following dot limited values.

• Module Type
• Module Label
• Module Sequence

Returns:

the string representation of the job module instance.

getJobName

public java.lang.String getJobName()

Return the job name.

Returns:

job name

setJobName

public JobDeploymentsPath setJobName(java.lang.String name)

Set the job name.

Parameters:

name - job name

Returns:

this object

getModuleType

public java.lang.String getModuleType()

Return the module type.

Returns:

module type

getModuleLabel

public java.lang.String getModuleLabel()

Return the module label.

Returns:

module label

setModuleLabel

public JobDeploymentsPath setModuleLabel(java.lang.String label)

Set the module label.

Parameters:

label - module label

Returns:

this object

getModuleSequenceAsString

public java.lang.String getModuleSequenceAsString()

Return the module sequence as string.

Returns:

module sequence

getModuleSequence

public int getModuleSequence()

Return the module sequence.

Returns:

module sequence

setModuleSequence

public JobDeploymentsPath setModuleSequence(java.lang.String moduleSequence)

Set the module sequence.

Parameters:

moduleSequence - module sequence

Returns:

this object

getContainer

public java.lang.String getContainer()

Return the container name.

Returns:

container name

setContainer

public JobDeploymentsPath setContainer(java.lang.String container)

Set the container name.

Parameters:

container - container name

Returns:

this object

build

public java.lang.String build()
                       throws java.lang.IllegalStateException

Build the path string using the field values.

Returns:

path string

Throws:

java.lang.IllegalStateException - if there are missing fields

See Also:

Paths.build(java.lang.String...)

buildWithNamespace

public java.lang.String buildWithNamespace()
                                    throws java.lang.IllegalStateException

Build the path string using the field values, including the namespace prefix.

Returns:

path string with namespace

Throws:

java.lang.IllegalStateException - if there are missing fields

See Also:

Paths.buildWithNamespace(java.lang.String...)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object