com.lightstreamer.interfaces.metadata
Interface CustomizableItemEvent

All Superinterfaces:

ItemEvent

public interface CustomizableItemEvent
extends ItemEvent

Used to provide update informations to the calls to the customizeUpdate method of MetadataProvider. Contains an update event for an Item, as dispatched by the Preprocessor in order to be processed by an ItemEventBuffer. All the fields pertaining to the updated Item state are reported, regardless that they are changing or confirmed with the event. The fields can be changed by supplying a new value, either as a String or as a byte array. New fields can be added to the event as well. Fields can also be removed, by setting them to null.

Method Summary

void	setValueAsByteArray(java.lang.String fieldName, byte[] value) Sets the value of a named Field as a byte array (null is a legal value too).
void	setValueAsString(java.lang.String fieldName, java.lang.String value) Sets the value of a named Field as a String object (null is a legal value too).

Methods inherited from interface com.lightstreamer.interfaces.metadata.ItemEvent

getValueAsByteArray, getValueAsString, isSnapshot

Method Detail

setValueAsString

void setValueAsString(java.lang.String fieldName,
                      java.lang.String value)

Sets the value of a named Field as a String object (null is a legal value too). Setting the value as a String may involve a conversion to a byte array in order to send the update to the client.

Parameters:

fieldName - A Field name.

value - a String containing a new value for the Field, or null.

setValueAsByteArray

void setValueAsByteArray(java.lang.String fieldName,
                         byte[] value)

Sets the value of a named Field as a byte array (null is a legal value too). Setting the value as a byte array rather than a String saves an internal conversion in order to send the update to the client.

Parameters:

fieldName - A Field name.

value - a byte array representing a new value for the Field, or null.