com::wombat::mama::MamaMsgFieldIterator

More…

Inherited by com.wombat.mama.MamaFieldCache.FieldCacheBasicMsgIterator, com.wombat.mama.MamaFieldCache.FieldCacheMsgIterator

Public Functions

Detailed Description

class com::wombat::mama::MamaMsgFieldIterator;

Callback interface for MamaMsg.iterateFields(). An object implementing this interface is passed to the [MamaMsg.iterateFields()](classcom_1_1wombat_1_1mama_1_1MamaMsg.html#function-iteratefields) method. The [onField()](interfacecom_1_1wombat_1_1mama_1_1MamaMsgFieldIterator.html#function-onfield) method is invoked for each field in the MamaMsg object.

Public Functions Documentation

function onField

void onField(
    MamaMsg msg,
    MamaMsgField field,
    MamaDictionary dict,
    Object closure
)

Parameters:

• msg The MamaMsg on which iterateFields() was called
• field The MamaMsgField object representing the underlying message field.
• dict The MamaDictionary object if one was passed to iterateFields()
• closure The closure object passed to the [MamaMsg.iterateFields()](classcom_1_1wombat_1_1mama_1_1MamaMsg.html#function-iteratefields) method

Method invoked for each field in the underlying message. Please note that the same single instance of the MamaMsgField is passed to this method in all callbacks during iteration on a single message. The state of the object is set for each invocation. This decision helps to reduce unnecessary creation of many new, short lived, objects when parsing messages. As such is is recommended that references to MamaMsgField instances are not maintained after the completion of the onField method.

Updated on 2023-03-31 at 15:29:43 +0100