org.marketcetera.ors.info
Interface ReadWriteInfo

All Superinterfaces:

ReadInfo

All Known Subinterfaces:

RequestInfo, SessionInfo

All Known Implementing Classes:

RequestInfoImpl, SessionInfoImpl, SystemInfoImpl

public interface ReadWriteInfo
extends ReadInfo

A generic store of key-value pairs whose contents are checked against certain conditions during management operations.

Since:

2.0.0

Version:

$Id: ReadWriteInfo.java 16154 2012-07-14 16:34:05Z colin $

Author:

tlerios@marketcetera.com

Method Summary

void	removeValue(String key) Removes the value associated with the given key in the receiver's map.
void	removeValueIfSet(String key) Removes the value associated with the given key in the receiver's map.
void	setValue(String key, Object value) Sets the value associated with the given key to the given value in the receiver's map.
void	setValueIfUnset(String key, Object value) Sets the value associated with the given key to the given value in the receiver's map.

Methods inherited from interface org.marketcetera.ors.info.ReadInfo

contains, getName, getPath, getValue, getValueIfInstanceOf, getValueIfNonNull, getValueIfNonNullInstanceOf, getValueIfSet

Method Detail

setValue

void setValue(String key,
              Object value)

Sets the value associated with the given key to the given value in the receiver's map.

Parameters:

key - The key.

value - The value. It may be null.

setValueIfUnset

void setValueIfUnset(String key,
                     Object value)
                     throws InfoException

Sets the value associated with the given key to the given value in the receiver's map.

Parameters:

key - The key.

value - The value. It may be null.

Throws:

InfoException - Thrown if a value is already associated with the given key.

removeValue

void removeValue(String key)

Removes the value associated with the given key in the receiver's map. It is a no-op if there is no value associated with the given key.

Parameters:

key - The key.

removeValueIfSet

void removeValueIfSet(String key)
                      throws InfoException

Removes the value associated with the given key in the receiver's map.

Parameters:

key - The key.

Throws:

InfoException - Thrown if no value is associated with the given key.