Package ghidra.program.model.data

Interface ParameterDefinition

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getComment()
      Get the Comment for this variable
      DataType getDataType()
      Get the Data Type of this variable
      int getLength()
      Get the length of this variable
      java.lang.String getName()
      Get the Name of this variable.
      int getOrdinal()
      Get the parameter ordinal
      boolean isEquivalent​(ParameterDefinition parm)
      Determine if parm is equivalent to this parameter definition by both ordinal and datatype.
      boolean isEquivalent​(Variable variable)
      Determine if a variable corresponds to a parameter which is equivalent to this parameter definition by both ordinal and datatype.
      void setComment​(java.lang.String comment)
      Set the comment for this variable
      void setDataType​(DataType type)
      Set the Data Type of this variable.
      void setName​(java.lang.String name)
      Set the name of this variable.

      • Methods inherited from interface java.lang.Comparable

        compareTo

    • Method Detail

      • getOrdinal

        int getOrdinal()
        Get the parameter ordinal
        Returns:
        the ordinal (index) of this parameter within the function signature.

      • getDataType

        DataType getDataType()
        Get the Data Type of this variable
        Returns:
        the data type of the variable

      • setDataType

        void setDataType​(DataType type)
          throws java.lang.IllegalArgumentException
        Set the Data Type of this variable.
        Parameters:
        type - dataType the fixed-length datatype of the parameter
        Throws:
        java.lang.IllegalArgumentException - if invalid parameter datatype specified

      • getName

        java.lang.String getName()
        Get the Name of this variable.
        Returns:
        the name of the variable or null if no name has been specified.

      • getLength

        int getLength()
        Get the length of this variable
        Returns:
        the length of the variable

      • setName

        void setName​(java.lang.String name)
        Set the name of this variable.
        Parameters:
        name - the name

      • getComment

        java.lang.String getComment()
        Get the Comment for this variable
        Returns:
        the comment

      • setComment

        void setComment​(java.lang.String comment)
        Set the comment for this variable
        Parameters:
        comment - the comment

      • isEquivalent

        boolean isEquivalent​(Variable variable)
        Determine if a variable corresponds to a parameter which is equivalent to this parameter definition by both ordinal and datatype. Name is not considered relevant.
        Parameters:
        variable - variable to be compared with this parameter definition.
        Returns:
        true if the specified variable represents the same parameter by ordinal and dataType. False will always be returned if specified variable is not a Parameter.

      • isEquivalent

        boolean isEquivalent​(ParameterDefinition parm)
        Determine if parm is equivalent to this parameter definition by both ordinal and datatype. Name is not considered relevant.
        Parameters:
        parm - parameter definition to be compared with this parameter definition.
        Returns:
        true if the specified parameter definition represents the same parameter by ordinal and dataType.