com.lightstreamer.interfaces.metadata

Interface CustomizableItemEvent

All Superinterfaces:

ItemEvent

public interface CustomizableItemEvent
extends ItemEvent

Used to provide update information 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

Modifier and Type	Method and Description
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).
If a value is supplied as a String, it will be received as an equivalent string object by the client. This, however, involves an internal conversion to a byte array in order to send the update; this makes supplying values as String less efficient than supplying them as byte arrays, though the latter method is restricted to the ISO-8859-1 (ISO-LATIN-1) character set.

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).
If a value is supplied as a byte array, it will be considered as an ISO-8859-1 (ISO-LATIN-1) representation of a string, so that the clients will be able to receive the value as a string object. A special case is that of binary representations of AMF objects, which can be received by the Flex Client Library in binary form. As another special case, the mandatory fields for COMMAND Mode, named "key" and "command", cannot be supplied as byte arrays.

Parameters:

fieldName - A Field name.

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