Package ghidra.program.model.data
Class ParameterDefinitionImpl
- java.lang.Object
-
- ghidra.program.model.data.ParameterDefinitionImpl
-
- All Implemented Interfaces:
ParameterDefinition,java.lang.Comparable<ParameterDefinition>
public class ParameterDefinitionImpl extends java.lang.Object implements ParameterDefinition
-
-
Constructor Summary
Constructors Modifier Constructor Description ParameterDefinitionImpl(java.lang.String name, DataType dataType, java.lang.String comment)Constructs a new ParameterImp with an unassigned ordinal.protectedParameterDefinitionImpl(java.lang.String name, DataType dataType, java.lang.String comment, int ordinal)Constructs a new ParameterImp
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DataTypecheckDataType(DataType dataType, DataTypeManager dtMgr)intcompareTo(ParameterDefinition p)booleanequals(java.lang.Object obj)java.lang.StringgetComment()Get the Comment for this variableDataTypegetDataType()Get the Data Type of this variableintgetLength()Get the length of this variablejava.lang.StringgetName()Get the Name of this variable.intgetOrdinal()Returns the ordinal (index) of this parameter within the function signature.booleanisEquivalent(ParameterDefinition parm)Returns true if the specified parameter definition represents the same parameter by ordinal and dataTypebooleanisEquivalent(Variable variable)Returns true if the specified variable represents the same parameter by ordinal and dataTypevoidsetComment(java.lang.String comment)Set the comment for this variablevoidsetDataType(DataType type)Set the Data Type of this variable.voidsetName(java.lang.String name)Set the name of this variable.java.lang.StringtoString()
-
-
-
Constructor Detail
-
ParameterDefinitionImpl
public ParameterDefinitionImpl(java.lang.String name, DataType dataType, java.lang.String comment)Constructs a new ParameterImp with an unassigned ordinal. The ordinal will be established by the function definition.- Parameters:
name- the name of the parameter.dataType- the datatype of the parametercomment- the comment to store about this parameter.
-
ParameterDefinitionImpl
protected ParameterDefinitionImpl(java.lang.String name, DataType dataType, java.lang.String comment, int ordinal)Constructs a new ParameterImp- Parameters:
name- the name of the parameter.dataType- the datatype of the parametercomment- the comment to store about this parameter.ordinal- the index of this parameter within the function signature.
-
-
Method Detail
-
checkDataType
public static DataType checkDataType(DataType dataType, DataTypeManager dtMgr)
-
compareTo
public final int compareTo(ParameterDefinition p)
- Specified by:
compareToin interfacejava.lang.Comparable<ParameterDefinition>- See Also:
Comparable.compareTo(java.lang.Object)
-
getOrdinal
public int getOrdinal()
Description copied from interface:ParameterDefinitionReturns the ordinal (index) of this parameter within the function signature.- Specified by:
getOrdinalin interfaceParameterDefinition
-
getComment
public java.lang.String getComment()
Description copied from interface:ParameterDefinitionGet the Comment for this variable- Specified by:
getCommentin interfaceParameterDefinition- Returns:
- the comment
-
getDataType
public DataType getDataType()
Description copied from interface:ParameterDefinitionGet the Data Type of this variable- Specified by:
getDataTypein interfaceParameterDefinition- Returns:
- the data type of the variable
-
getLength
public int getLength()
Description copied from interface:ParameterDefinitionGet the length of this variable- Specified by:
getLengthin interfaceParameterDefinition- Returns:
- the length of the variable
-
getName
public java.lang.String getName()
Description copied from interface:ParameterDefinitionGet the Name of this variable.- Specified by:
getNamein interfaceParameterDefinition- Returns:
- the name of the variable or null if no name has been specified.
-
setComment
public void setComment(java.lang.String comment)
Description copied from interface:ParameterDefinitionSet the comment for this variable- Specified by:
setCommentin interfaceParameterDefinition- Parameters:
comment- the comment
-
setDataType
public void setDataType(DataType type) throws InvalidInputException
Description copied from interface:ParameterDefinitionSet the Data Type of this variable. The given dataType must have a fixed length.- Specified by:
setDataTypein interfaceParameterDefinition- Parameters:
type- the data type- Throws:
InvalidInputException- if data type is not a fixed length or will not fit.
-
setName
public void setName(java.lang.String name)
Description copied from interface:ParameterDefinitionSet the name of this variable.- Specified by:
setNamein interfaceParameterDefinition- Parameters:
name- the name
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
isEquivalent
public boolean isEquivalent(Variable variable)
Description copied from interface:ParameterDefinitionReturns true if the specified variable represents the same parameter by ordinal and dataType- Specified by:
isEquivalentin interfaceParameterDefinition
-
isEquivalent
public boolean isEquivalent(ParameterDefinition parm)
Description copied from interface:ParameterDefinitionReturns true if the specified parameter definition represents the same parameter by ordinal and dataType- Specified by:
isEquivalentin interfaceParameterDefinition
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-