org.springframework.xd.module

Class ModuleDeploymentProperties

java.lang.Object

org.springframework.xd.module.ModuleDeploymentProperties

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.String>

Direct Known Subclasses:

RuntimeModuleDeploymentProperties

public class ModuleDeploymentProperties
extends java.lang.Object
implements java.util.Map<java.lang.String,java.lang.String>

Deployment properties for a module.

Author:

Mark Fisher, Gary Russell

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COUNT_KEY Key for the count property.
static java.lang.String	CRITERIA_KEY Key for the criteria property.
static ModuleDeploymentProperties	defaultInstance Default instance of ModuleDeploymentProperties.
static java.lang.String	TRACK_HISTORY_KEY Key for the trackHistory property.

Constructor Summary

Constructors

Constructor and Description
ModuleDeploymentProperties() Create a map to hold module deployment properties.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>	entrySet()
java.lang.String	get(java.lang.Object key)
int	getCount() Return the number of container instances this module should be deployed to.
java.lang.String	getCriteria() Return the criteria expression to evaluate against container attributes to determine deployment candidates for this module.
boolean	getTrackHistory() Return the trackHistory property for this module.
boolean	isEmpty()
java.util.Set<java.lang.String>	keySet()
java.lang.String	put(java.lang.String key, java.lang.String value)
void	putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> m)
java.lang.String	remove(java.lang.Object key)
ModuleDeploymentProperties	setCount(int count) Specify the number of container instances this module should be deployed to.
ModuleDeploymentProperties	setCriteria(java.lang.String criteria) Specify the criteria expression to evaluate against container attributes to determine deployment candidates for this module.
ModuleDeploymentProperties	setTrackHistory(boolean trackHistory) Specify the trackHistory property for this module.
int	size()
java.lang.String	toString()
java.util.Collection<java.lang.String>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

defaultInstance

public static final ModuleDeploymentProperties defaultInstance

Default instance of ModuleDeploymentProperties. This instance uses default values for all mandatory properties.

COUNT_KEY

public static final java.lang.String COUNT_KEY

Key for the count property. Value should be an integer.

See Also:

Constant Field Values

CRITERIA_KEY

public static final java.lang.String CRITERIA_KEY

Key for the criteria property. Value should be a SpEL expression.

See Also:

Constant Field Values

TRACK_HISTORY_KEY

public static final java.lang.String TRACK_HISTORY_KEY

Key for the trackHistory property. Value should be a boolean.

See Also:

Constant Field Values

Constructor Detail

ModuleDeploymentProperties

public ModuleDeploymentProperties()

Create a map to hold module deployment properties. The only initial value will be a count of 1.

Method Detail

getCount

public int getCount()

Return the number of container instances this module should be deployed to. A value of 0 indicates that this module should be deployed to all containers that match the provided target expression. If no target expression were provided and the count value is 0, this module should be deployed to all containers.

Returns:

number of container instances

setCount

public ModuleDeploymentProperties setCount(int count)

Specify the number of container instances this module should be deployed to. A value of 0 indicates that this module should be deployed to all containers in the group. If group is null and the value is 0, this module should be deployed to all containers.

getCriteria

public java.lang.String getCriteria()

Return the criteria expression to evaluate against container attributes to determine deployment candidates for this module.

Returns:

criteria expression or null if no criteria expression was specified.

setCriteria

public ModuleDeploymentProperties setCriteria(java.lang.String criteria)

Specify the criteria expression to evaluate against container attributes to determine deployment candidates for this module.

getTrackHistory

public boolean getTrackHistory()

Return the trackHistory property for this module.

Returns:

true if history should be tracked.

setTrackHistory

public ModuleDeploymentProperties setTrackHistory(boolean trackHistory)

Specify the trackHistory property for this module.

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.String,java.lang.String>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.String,java.lang.String>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.lang.String>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.String,java.lang.String>

get

public java.lang.String get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.String>

put

public java.lang.String put(java.lang.String key,
                   java.lang.String value)

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.String>

remove

public java.lang.String remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.String,java.lang.String>

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> m)

Specified by:

putAll in interface java.util.Map<java.lang.String,java.lang.String>

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.String,java.lang.String>

keySet

public java.util.Set<java.lang.String> keySet()

Specified by:

keySet in interface java.util.Map<java.lang.String,java.lang.String>

values

public java.util.Collection<java.lang.String> values()

Specified by:

values in interface java.util.Map<java.lang.String,java.lang.String>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> entrySet()

Specified by:

entrySet in interface java.util.Map<java.lang.String,java.lang.String>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object