Class FunctionRepeatableCommentFieldLocation

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

    public class FunctionRepeatableCommentFieldLocation
    extends FunctionLocation
    The FunctionRepeatableCommentFieldLocation class provides specific information about the Function Repeatable Comment field within a program location.
    • Constructor Detail

      • FunctionRepeatableCommentFieldLocation

        public FunctionRepeatableCommentFieldLocation​(Program program,
                                                      Address locationAddr,
                                                      Address functionAddr,
                                                      java.lang.String[] comment,
                                                      int row,
                                                      int charOffset)
        Construct a new FunctionRepeatableCommentFieldLocation object.
        Parameters:
        program - the program of the location
        locationAddr - the address of the listing location (i.e., referent code unit)
        functionAddr - the function address
        comment - the function comment array String at this location.
        row - row number (index into the comment array)
        charOffset - character position within the comment, indexed by row
      • FunctionRepeatableCommentFieldLocation

        public FunctionRepeatableCommentFieldLocation​(Program program,
                                                      Address functionAddr,
                                                      java.lang.String[] comment,
                                                      int row,
                                                      int col)
        Construct a new FunctionRepeatableCommentFieldLocation object.
        Parameters:
        program - the program of the location
        functionAddr - the function address (must not be an EXTERNAL function)
        comment - the function comment array String at this location.
        row - row number (index into the comment array)
        col - character position within the comment, indexed by row
      • FunctionRepeatableCommentFieldLocation

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

      • getComment

        public java.lang.String[] getComment()
        Return the function comment string at this location.
      • 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