Package com.wombat.mama

Class MamaFieldDescriptor

  • public class MamaFieldDescriptor
extends java.lang.Object
    The MamaFieldDescriptor class represents a field in a MamaMsg
    See Also:
    MamaDictionary, MamaMsg

    • Constructor Detail

      • MamaFieldDescriptor

        public MamaFieldDescriptor​(int fid,
                           short type,
                           java.lang.String name,
                           java.lang.Object data)
        Create a MamaFieldDescriptor
        Parameters:
        fid - The field identifier.
        type - The type.
        name - The field name.

    • Method Detail

      • getFid

        public int getFid()
        Return the field identifier.
        Returns:
        The fid.

      • getType

        public short getType()
        Return the data type.
        Returns:
        The type.

      • getName

        public java.lang.String getName()
        Return the human readable name of the field.
        Returns:
        The name.

      • toString

        public java.lang.String toString()
        Returns a string suitable for output to a terminal containing the type, id, and name.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A human readable string for the field.

      • setClosure

        public void setClosure​(java.lang.Object closure)
        Set user specified data to associate with the field descriptor.
        Parameters:
        closure - The data to associate with the descriptor.

      • getClosure

        public java.lang.Object getClosure()
        Return the user specified data associated with the field descriptor. The closure data has a default value of null
        Returns:
        The user specified data associated with the field descriptor.

      • getTypeName

        public static java.lang.String getTypeName​(short type)

      • setTrackModState

        public void setTrackModState​(boolean on)

      • getTrackModState

        public boolean getTrackModState()