com.solacesystems.jcsmp

Class JCSMPPropertyMap

java.lang.Object

com.solacesystems.jcsmp.JCSMPPropertyMap

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

JCSMPProperties

public class JCSMPPropertyMap
extends Object
implements Serializable, Cloneable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JCSMPPropertyMap()

Method Summary

Modifier and Type	Method and Description
Boolean	getBooleanProperty(String name) Searches for the property with the specified key in the property list and converts to Boolean.
Integer	getIntegerProperty(String name) Searches for the property with the specified key in the property list and converts to Integer.
Map<String,Object>	getProperties() Returns the property map.
Object	getProperty(String name) Searches for the property with the specified key in the property list.
String	getStringProperty(String name) Searches for the property with the specified key in the property list and converts to String.
Set<String>	propertyNames() Gets the set of property names (keys) currently in the property map.
Object	setBooleanProperty(String name, boolean value) Sets a property with the specified key and value in the property list, wrapping the value as a Boolean.
Object	setIntegerProperty(String name, int value) Sets a property with the specified key and value in the property list, wrapping the value as an Integer.
void	setProperties(Map<String,Object> properties) Bulk set of properties, invokes the HashMap.putAll(Map) method which copies entries from the provided map to the property map.
Object	setProperty(String name, Object value) Sets a property with the specified key and value in the property list.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JCSMPPropertyMap

public JCSMPPropertyMap()

Method Detail

getProperty

public Object getProperty(String name)

Searches for the property with the specified key in the property list. The method returns null if the property is not found or the key explicitly maps to null.

Parameters:

name - The name of the property.

getProperties

public Map<String,Object> getProperties()

Returns the property map.

Returns:

A map of the properties.

setProperty

public Object setProperty(String name,
                          Object value)

Sets a property with the specified key and value in the property list. The method returns the result of the put operation to the property map. Property values should match the expected type listed, such as Integer and Boolean properties.

Parameters:

name - The name of the property.

value - The value of the property.

Returns:

The result of the put operation.

setProperties

public void setProperties(Map<String,Object> properties)

Bulk set of properties, invokes the HashMap.putAll(Map) method which copies entries from the provided map to the property map. This overwrites existing properties with the same names.

Parameters:

properties - The map from which to copy properties.

getIntegerProperty

public Integer getIntegerProperty(String name)

Searches for the property with the specified key in the property list and converts to Integer. The method returns null if the property is not found, was not an Integer, or the key explicitly maps to null.

Parameters:

name - The name of the property.

Returns:

The result of the get operation or null.

getBooleanProperty

public Boolean getBooleanProperty(String name)

Searches for the property with the specified key in the property list and converts to Boolean. The method returns null if the property is not found, was not a Boolean, or the key explicitly maps to null.

Parameters:

name - The name of the property.

Returns:

The result of the get operation. (or null if the property is not found, was not a Boolean, or the key explicitly maps to null).

getStringProperty

public String getStringProperty(String name)

Searches for the property with the specified key in the property list and converts to String. The method returns null if the property is not found, was not a String, or the key explicitly maps to null.

Parameters:

name - The name of the property.

Returns:

The result of the get operation or null.

setIntegerProperty

public Object setIntegerProperty(String name,
                                 int value)

Sets a property with the specified key and value in the property list, wrapping the value as an Integer. The method returns the result of the put operation to the property map.

Parameters:

name - The name of the property.

value - The value of the property.

Returns:

The result of the put operation.

setBooleanProperty

public Object setBooleanProperty(String name,
                                 boolean value)

Sets a property with the specified key and value in the property list, wrapping the value as a Boolean. The method returns the result of the put operation to the property map.

Parameters:

name - The name of the property.

value - The value of the property.

Returns:

The result of the put operation.

propertyNames

public Set<String> propertyNames()

Gets the set of property names (keys) currently in the property map.

Returns:

The set of property names from the property map.