com.tibco.ftl

## Interface MessageFieldRef

-     public interface MessageFieldRef

  Field references enable efficiency gains when accessing message fields.

  The Message API provides two versions of each message field accessor method -- one accepts a field name, while the other accepts a field reference object. Access by field reference is more efficient than access by name alone.

  Field reference objects contain a field name, along with internal information that enables efficient access.

  Programs can repeatedly use a field reference object to efficiently access a field -- even across messages of different formats.

  For example, if formats `A` and `B` both have a field named `foo`, then a field reference object with field name `foo` accesses the correct field in messages of either format.

  Field reference objects are thread-safe. (However, the field reference that `MessageIterator.next` returns is an exception to this rule.)

  To create a field reference object, call `Realm.createMessageFieldRef`.

  Customers do not implement this interface.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `destroy()` Destroy a field reference object.
    `java.lang.String` | `getFieldName()` Get the field name from a field reference object.

- - ### Method Detail

    - #### destroy

          void destroy()

      Destroy a field reference object.

      Destroying a field reference object frees all resources associated with the field reference.

    - #### getFieldName

          java.lang.String getFieldName()

      Get the field name from a field reference object.
      Returns:
        Field name as a string.