org.jogre.common.comm
Interface ITransmittableWithProps

All Superinterfaces:

ITransmittable

All Known Implementing Classes:

CommNewTable, Table

public interface ITransmittableWithProps

extends ITransmittable

This interfaces denotates that the ITransmittable object contains a JogrePropertiesHash instance as a field. The class must also supply an addProperty (String key, String value) and getProperty (String key) methods from this interface.

The properties should be stored in a "properties" attribute in the ITransmittable.flatten () method when is read again using the object's constructor (String) method.

Version:

Alpha 0.2.3

Author:

Bob Marks

Field Summary

static String

XML_ATT_PROPERTIES Attribute name of properties.

Method Summary

void	addProperty(String key, String value) Add a property to a class.
JogrePropertyHash	getProperties() Return the properties hash.

Methods inherited from interface org.jogre.common.comm.ITransmittable

flatten

Field Detail

XML_ATT_PROPERTIES

public static final String XML_ATT_PROPERTIES

Attribute name of properties.

See Also:

Constant Field Values

Method Detail

getProperties

public JogrePropertyHash getProperties()

Return the properties hash.

Returns:

addProperty

public void addProperty(String key,
                        String value)

Add a property to a class. i.e. properties.put (key, value);

Parameters:

key - Key of the property

value - Value of the property