org.springframework.xd.dirt.container

Class ContainerAttributes

java.lang.Object

org.springframework.xd.dirt.container.ContainerAttributes

All Implemented Interfaces:

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

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

Metadata for a Container instance.

Author:

Mark Fisher, David Turanski, Ilayaperumal Gopinathan

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	CONTAINER_ID_KEY
static java.lang.String	GROUPS_KEY
static java.lang.String	HOST_KEY
static java.lang.String	IP_ADDRESS_KEY
static java.lang.String	PROCESS_ID_KEY

Constructor Summary

Constructors

Constructor and Description
ContainerAttributes() Default constructor generates a random id.
ContainerAttributes(java.util.Map<? extends java.lang.String,? extends java.lang.String> attributes) Constructor to be called when the attributes are already known.
ContainerAttributes(java.lang.String id) Constructor to be called when the id is already known.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
int	compareTo(ContainerAttributes other) Compares using the containerId.
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)
java.util.Map<java.lang.String,java.lang.String>	getCustomAttributes() Retrieve the custom attributes for this container.
java.util.Set<java.lang.String>	getGroups()
java.lang.String	getHost()
java.lang.String	getId()
java.lang.String	getIp()
int	getPid()
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)
ContainerAttributes	setHost(java.lang.String host)
ContainerAttributes	setIp(java.lang.String ip)
ContainerAttributes	setPid(java.lang.Integer pid)
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

CONTAINER_ID_KEY

public static final java.lang.String CONTAINER_ID_KEY

See Also:

Constant Field Values

HOST_KEY

public static final java.lang.String HOST_KEY

See Also:

Constant Field Values

PROCESS_ID_KEY

public static final java.lang.String PROCESS_ID_KEY

See Also:

Constant Field Values

GROUPS_KEY

public static final java.lang.String GROUPS_KEY

See Also:

Constant Field Values

IP_ADDRESS_KEY

public static final java.lang.String IP_ADDRESS_KEY

See Also:

Constant Field Values

Constructor Detail

ContainerAttributes

public ContainerAttributes()

Default constructor generates a random id.

ContainerAttributes

public ContainerAttributes(java.lang.String id)

Constructor to be called when the id is already known.

Parameters:

id - the container's id

ContainerAttributes

public ContainerAttributes(java.util.Map<? extends java.lang.String,? extends java.lang.String> attributes)

Constructor to be called when the attributes are already known. If an id is not present in the map, one will be generated.

Parameters:

attributes - the container's attributes

Method Detail

getId

public java.lang.String getId()

getHost

public java.lang.String getHost()

getIp

public java.lang.String getIp()

getPid

public int getPid()

getGroups

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

setPid

public ContainerAttributes setPid(java.lang.Integer pid)

setHost

public ContainerAttributes setHost(java.lang.String host)

setIp

public ContainerAttributes setIp(java.lang.String ip)

getCustomAttributes

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

Retrieve the custom attributes for this container. This will not include the values for common keys: "id", "pid", "host", "ip" and "groups"

Returns:

the map of custom attributes

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

compareTo

public int compareTo(ContainerAttributes other)

Compares using the containerId.

Specified by:

compareTo in interface java.lang.Comparable<ContainerAttributes>