com.jinfonet.ibus

Interface InformationContainer

public interface InformationContainer

The InformationContainer is used to store information of user. The information stored in InformationContainer can be one type in three types: LONG_TIME: the information exists in the container until it was removed or the container was released; SPECIFIED_TIME: the information exists in the container until arrived the specified time by the user or removed by user; ONCE_TIME: the information will be removed once it was gotten or removed by user. The objects stored in the information bus must be Serializable;

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_BUILT_IN_FUN_ACCESSIBLE_RESOURCES

Method Summary

Modifier and Type	Method and Description
java.util.List<java.io.Serializable>	getAllInfo() Gets all information stored in the container.
java.io.Serializable	getInfo(java.lang.String key) Gets the information from container.
void	putInfo(java.lang.String key, java.io.Serializable obj, InfoLifeCycleType lifeCycleType, java.lang.Object... lifeCycle) Pub information into the container.
boolean	removeInfo(java.lang.String key) Removes the information object from container.

Field Detail

KEY_BUILT_IN_FUN_ACCESSIBLE_RESOURCES

static final java.lang.String KEY_BUILT_IN_FUN_ACCESSIBLE_RESOURCES

See Also:

Constant Field Values

Method Detail

putInfo

void putInfo(java.lang.String key,
             java.io.Serializable obj,
             InfoLifeCycleType lifeCycleType,
             java.lang.Object... lifeCycle)

Pub information into the container.

Parameters:

key - The information key

obj - The information value

lifeCycleType - The information life cycle type, one of LONG_TIME, SPECIFIED_TIME, ONCE_TIME.

lifeCycle - The information life cycle, only need when lifeCycleType value is SPECIFIED_TIME. The lifeCycle can be int, long and Date, for int and long, the unit is millisecond. When the lifeCycle was specified by int or long millisecond, the obj will be removed from information container after it put into container specified millisecond. When the lifeCycle was specified by Date, the obj will be removed at the Date specified.

getInfo

java.io.Serializable getInfo(java.lang.String key)

Gets the information from container.

Parameters:

key - The information key.

Returns:

Serializable The serializable object stored in the information bus.

removeInfo

boolean removeInfo(java.lang.String key)

Removes the information object from container.

Parameters:

key - The information key.

Returns:

boolean Whether the information object was removed successfully.

getAllInfo

java.util.List<java.io.Serializable> getAllInfo()

Gets all information stored in the container.

Returns:

List all objects stored in the information bus.