org.axonframework.eventhandling

Interface ClusterMetaData

All Known Implementing Classes:

DefaultClusterMetaData

public interface ClusterMetaData

Allows arbitrary information to be attached to a cluster.

Since:

1.2

Author:

Allard Buijze

Method Summary

Methods

Modifier and Type	Method and Description
Object	getProperty(String key) Returns the property stored using the given key.
boolean	isPropertySet(String key) Indicates whether a value is stored under the given key.
void	removeProperty(String key) Removes the value store under the given key.
void	setProperty(String key, Object value) Stores a property value under the given key.

Method Detail

getProperty

Object getProperty(String key)

Returns the property stored using the given key. If no property has been stored using that key, it returns null.

Parameters:

key - The key under which the property was stored

Returns:

The value stored under the given key

setProperty

void setProperty(String key,
               Object value)

Stores a property value under the given key.

Parameters:

key - the key under which to store a value

value - the value to store

removeProperty

void removeProperty(String key)

Removes the value store under the given key. If no such value is available, nothing happens.

Parameters:

key - the key to remove

isPropertySet

boolean isPropertySet(String key)

Indicates whether a value is stored under the given key. Will also return true if a null value is stored under the given key.

Parameters:

key - The key to find

Returns:

true if a value was stored under the given key, otherwise false.