Class SubDataFieldLocation

  • All Implemented Interfaces:
    java.lang.Comparable<ProgramLocation>

    public class SubDataFieldLocation
    extends CodeUnitLocation
    The SubDataFieldLocation class contains specific location information within the Sub-data field of a CodeUnitLocation object.
    • Constructor Detail

      • SubDataFieldLocation

        public SubDataFieldLocation​(Program program,
                                    Address addr,
                                    GroupPath path,
                                    int[] componentPath,
                                    Address refAddr,
                                    java.lang.String rep,
                                    int charOffset,
                                    java.lang.String fieldName)
        Construct a new SubDataFieldLocation object.
        Parameters:
        program - the program of the location
        addr - address of the location
        path - path associated with the address (an address could appear at more than one group path); may be null
        componentPath - array of indexes for each nested data component; the index is the data component's index within its parent; may be null
        refAddr - the "referred to" address if the location is over a reference; may be null
        rep - the String representation of the operand.
        charOffset - the character position within the operand string.
        fieldName - the name of the sub-data field
      • SubDataFieldLocation

        public SubDataFieldLocation()
        Should only be used by XML restoration.
    • Method Detail

      • getDataRepresentation

        public java.lang.String getDataRepresentation()
        Returns a string representation of the dataValue at this location.
      • getFieldName

        public java.lang.String getFieldName()
        Returns the name of the sub-data field.
      • toString

        public java.lang.String toString()
        Returns a String representation of this location.
        Overrides:
        toString in class ProgramLocation
      • restoreState

        public void restoreState​(Program p,
                                 SaveState obj)
        Description copied from class: ProgramLocation
        Restore this program location using the given program and save state object.
        Overrides:
        restoreState in class ProgramLocation
        Parameters:
        p - program to restore from
        obj - the save state to restore from
      • saveState

        public void saveState​(SaveState obj)
        Description copied from class: ProgramLocation
        Save this program location to the given save state object.
        Overrides:
        saveState in class ProgramLocation
        Parameters:
        obj - the save state object for saving the location