Class DSFieldImpl

  • All Implemented Interfaces:
    DSField

    public class DSFieldImpl
    extends java.lang.Object
    implements DSField

    Transformer module implementation of the DSField interface.

    This class has the default (package protected) modifier to prevent the end user from being able to access this class directly.

    • Constructor Summary

      Constructors 
      Constructor Description
      DSFieldImpl​(long dsDataPointer, int fieldIndex, int fieldNumber, java.lang.String fieldValue)
      Constructs a DSFieldImpl with the specified pointer to the underlying ds_data struct, index, field number and value.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      FieldInfo getFieldInfo()
      Get the field information for this field, if available.
      int getFlags()
      Get the flags set on this field.
      java.lang.String getValue()
      Gets the value for the field.
      void setFieldInfo​(FieldInfo fieldInfo)
      Sets the field information for the field.
      void setValue​(java.lang.String fieldValue)
      Sets the value for the field.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DSFieldImpl

        public DSFieldImpl​(long dsDataPointer,
                           int fieldIndex,
                           int fieldNumber,
                           java.lang.String fieldValue)

        Constructs a DSFieldImpl with the specified pointer to the underlying ds_data struct, index, field number and value.

        This constructor has the default (package protected) modifier to prevent the end user from being able to instantiate this class.

        Parameters:
        dsDataPointer - The pointer to the C ds_data struct that holds the state information for the update.
        fieldIndex - The index of the field within the ds_data struct.
        fieldNumber - The field number.
        fieldValue - The value of the field.
    • Method Detail

      • getValue

        public java.lang.String getValue()
        Description copied from interface: DSField

        Gets the value for the field.

        Specified by:
        getValue in interface DSField
        Returns:
        The field's value.
      • setValue

        public void setValue​(java.lang.String fieldValue)
        Description copied from interface: DSField

        Sets the value for the field.

        Specified by:
        setValue in interface DSField
        Parameters:
        fieldValue - The new field value.
      • getFieldInfo

        public FieldInfo getFieldInfo()
        Description copied from interface: DSField

        Get the field information for this field, if available.

        Specified by:
        getFieldInfo in interface DSField
        Returns:
        the FieldInfo for this field, or null if not available
      • setFieldInfo

        public void setFieldInfo​(FieldInfo fieldInfo)
        Description copied from interface: DSField

        Sets the field information for the field.

        Specified by:
        setFieldInfo in interface DSField
        Parameters:
        fieldInfo - The new FieldInfo for this field.
      • getFlags

        public int getFlags()
        Description copied from interface: DSField
        Get the flags set on this field.
        Specified by:
        getFlags in interface DSField
        Returns:
        the flags set on this field