com.ibm.xsp.application
Class ComponentParameters

java.lang.Object
  com.ibm.xsp.application.ComponentParameters

All Implemented Interfaces:

DataObject, java.io.Serializable

public class ComponentParameters
extends java.lang.Object
implements java.io.Serializable, DataObject

Component properties. This class handles the component properties, when the session is executed as a Component.

See Also:

Serialized Form

Constructor Summary

ComponentParameters()
Required by Serializable.

Method Summary

java.lang.String	getAsJson() Get the properties as a JSON string.
java.util.Iterator<java.lang.String>	getPropertyNames() Enumerate the property names.
java.lang.Class<?>	getType(java.lang.Object key) Set a property value.
java.lang.Object	getValue(java.lang.Object key) Get a property value.
boolean	isReadOnly(java.lang.Object key) Check if a property is read-only.
void	setFromJson(java.lang.String json) Set the properties from a JSON string.
void	setValue(java.lang.Object key, java.lang.Object value) Set a property value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentParameters

public ComponentParameters()

Required by Serializable.

Method Detail

getPropertyNames

public java.util.Iterator<java.lang.String> getPropertyNames()

Enumerate the property names.

getAsJson

public java.lang.String getAsJson()

Get the properties as a JSON string.

setFromJson

public void setFromJson(java.lang.String json)

Set the properties from a JSON string.

getValue

public java.lang.Object getValue(java.lang.Object key)

Get a property value.

Specified by:

getValue in interface DataObject

Parameters:

key - key whose associated value is to be returned.

Returns:

the value to which this data object maps the specified key, or null if the data object contains no mapping for this key.

setValue

public void setValue(java.lang.Object key,
                     java.lang.Object value)

Set a property value.

Specified by:

setValue in interface DataObject

Parameters:

key - key with which the specified value is to be associated.

value - value to be associated with the specified key.

getType

public java.lang.Class<?> getType(java.lang.Object key)

Set a property value.

Specified by:

getType in interface DataObject

Parameters:

key - key with which the specified value is to be associated.

Returns:

the type to which this data object maps the specified key, or null if the data object contains no mapping for this key (or undefined)

isReadOnly

public boolean isReadOnly(java.lang.Object key)

Check if a property is read-only.

Specified by:

isReadOnly in interface DataObject

Parameters:

key - key of the specified value to be tested.

Returns:

true if the specified data object is known to be immutable; otherwise, return false.