Class FunctionSignatureSourceFieldLocation

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

    public class FunctionSignatureSourceFieldLocation
    extends FunctionLocation
    The FunctionSignatureFieldLocation class provides specific information about the Function Signature field within a program location.
    • Constructor Detail

      • FunctionSignatureSourceFieldLocation

        public FunctionSignatureSourceFieldLocation​(Program program,
                                                    Address locationAddr,
                                                    Address functionAddr,
                                                    java.lang.String source,
                                                    int charOffset)
        Construct a new FunctionSignatureFieldLocation object.
        Parameters:
        program - the program of the location
        locationAddr - the address of this location.
        functionAddr - the function address
        source - the function signature SourceType at this location.
        charOffset - field character position
      • FunctionSignatureSourceFieldLocation

        public FunctionSignatureSourceFieldLocation()
        Default constructor needed for restoring a program location from XML
    • Method Detail

      • getSignatureSource

        public java.lang.String getSignatureSource()
        Return the function signature source at this location.
        See Also:
        SourceType
      • toString

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

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class FunctionLocation
        See Also:
        Object.equals(java.lang.Object)
      • saveState

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

        public void restoreState​(Program p,
                                 SaveState obj)
        Description copied from class: FunctionLocation
        Restore this function location using the given program and save state object.
        Overrides:
        restoreState in class FunctionLocation
        Parameters:
        p - the program containing the function location
        obj - the save state object for saving the location