Package ghidra.program.model.data
Class ReadOnlyDataTypeComponent
- java.lang.Object
-
- ghidra.program.model.data.ReadOnlyDataTypeComponent
-
- All Implemented Interfaces:
DataTypeComponent
,java.io.Serializable
public class ReadOnlyDataTypeComponent extends java.lang.Object implements DataTypeComponent, java.io.Serializable
DataTypeComponents from dataTypes that can not be modified.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from interface ghidra.program.model.data.DataTypeComponent
DEFAULT_FIELD_NAME_PREFIX
-
-
Constructor Summary
Constructors Constructor Description ReadOnlyDataTypeComponent(DataType dataType, DynamicDataType parent, int length, int ordinal, int offset)
Create a new DataTypeComponentReadOnlyDataTypeComponent(DataType dataType, DynamicDataType parent, int length, int ordinal, int offset, java.lang.String fieldName, java.lang.String comment)
Create a new DataTypeComponent
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.String
getComment()
Get the comment for this dataTypeComponent.DataType
getDataType()
Returns the dataType in this component.java.lang.String
getDefaultFieldName()
Returns a default Field name.Settings
getDefaultSettings()
Gets the default settings for this data type component.int
getEndOffset()
Get the byte offset of where this component ends relative to the start of the parent data type.java.lang.String
getFieldName()
Get the name of the field name as a component of a Data Type.int
getLength()
Get the length of this component.int
getOffset()
Get the byte offset of where this component begins relative to the start of the parent data type.int
getOrdinal()
Get the ordinal position within the parent dataType.DataType
getParent()
returns the dataType that contains this component.boolean
isBitFieldComponent()
Determine if the specified component corresponds to a bit-field.boolean
isEquivalent(DataTypeComponent dtc)
Returns true if the given dataTypeComponent is equivalent to this dataTypeComponent.boolean
isZeroBitFieldComponent()
Determine if the specified component corresponds to a zero-length bit-field.void
setComment(java.lang.String comment)
Sets the comment for the component.void
setDefaultSettings(Settings settings)
Set default settings for this dataType.void
setFieldName(java.lang.String fieldName)
Sets the field name.
-
-
-
Constructor Detail
-
ReadOnlyDataTypeComponent
public ReadOnlyDataTypeComponent(DataType dataType, DynamicDataType parent, int length, int ordinal, int offset, java.lang.String fieldName, java.lang.String comment)
Create a new DataTypeComponent- Parameters:
dataType
- the dataType for this componentparent
- the dataType that this component belongs tolength
- the length of the dataType in this component.offset
- the byte offset within the parentordinal
- the index of this component in the parent.fieldName
- the name associated with this componentcomment
- the comment associated with ths component
-
ReadOnlyDataTypeComponent
public ReadOnlyDataTypeComponent(DataType dataType, DynamicDataType parent, int length, int ordinal, int offset)
Create a new DataTypeComponent- Parameters:
dataType
- the dataType for this componentparent
- the dataType that this component belongs tolength
- the length of the dataType in this component.ordinal
- the index of this component in the parent.offset
- the byte offset within the parent
-
-
Method Detail
-
isBitFieldComponent
public boolean isBitFieldComponent()
Description copied from interface:DataTypeComponent
Determine if the specified component corresponds to a bit-field.- Specified by:
isBitFieldComponent
in interfaceDataTypeComponent
- Returns:
- true if bit-field else false
-
isZeroBitFieldComponent
public boolean isZeroBitFieldComponent()
Description copied from interface:DataTypeComponent
Determine if the specified component corresponds to a zero-length bit-field.- Specified by:
isZeroBitFieldComponent
in interfaceDataTypeComponent
- Returns:
- true if zero-length bit-field else false
-
getOffset
public int getOffset()
Description copied from interface:DataTypeComponent
Get the byte offset of where this component begins relative to the start of the parent data type.- Specified by:
getOffset
in interfaceDataTypeComponent
- Returns:
- offset of start of component relative to the start of the parent data type.
-
getEndOffset
public int getEndOffset()
Description copied from interface:DataTypeComponent
Get the byte offset of where this component ends relative to the start of the parent data type.- Specified by:
getEndOffset
in interfaceDataTypeComponent
- Returns:
- offset of end of component relative to the start of the parent data type.
-
getComment
public java.lang.String getComment()
Description copied from interface:DataTypeComponent
Get the comment for this dataTypeComponent.- Specified by:
getComment
in interfaceDataTypeComponent
- Returns:
- component comment string or null if one has not been set
-
setComment
public void setComment(java.lang.String comment)
Description copied from interface:DataTypeComponent
Sets the comment for the component.- Specified by:
setComment
in interfaceDataTypeComponent
- Parameters:
comment
- this components comment or null to clear comment.
-
getFieldName
public java.lang.String getFieldName()
Description copied from interface:DataTypeComponent
Get the name of the field name as a component of a Data Type.- Specified by:
getFieldName
in interfaceDataTypeComponent
- Returns:
- the name as a component of another Data Type.
-
getDefaultFieldName
public java.lang.String getDefaultFieldName()
Description copied from interface:DataTypeComponent
Returns a default Field name. Used only if a field name is not set.- Specified by:
getDefaultFieldName
in interfaceDataTypeComponent
- Returns:
- default field name
-
setFieldName
public void setFieldName(java.lang.String fieldName) throws DuplicateNameException
Description copied from interface:DataTypeComponent
Sets the field name. If the field name is empty it will be set to null, which is the default field name. An exception is thrown if one of the parent's other components already has the specified field name.- Specified by:
setFieldName
in interfaceDataTypeComponent
- Parameters:
fieldName
- the new field name for this component.- Throws:
DuplicateNameException
- if another component of the parent has the specified field name.
-
getDataType
public DataType getDataType()
Description copied from interface:DataTypeComponent
Returns the dataType in this component.- Specified by:
getDataType
in interfaceDataTypeComponent
- Returns:
- the dataType in this component
-
getParent
public DataType getParent()
Description copied from interface:DataTypeComponent
returns the dataType that contains this component.- Specified by:
getParent
in interfaceDataTypeComponent
- Returns:
- the dataType that contains this component.
-
getLength
public int getLength()
Description copied from interface:DataTypeComponent
Get the length of this component. Zero-length components will report a length of 0 and may overlap other components at the same offset. Similarly, multiple adjacent bit-field components may appear to overlap at the byte-level.- Specified by:
getLength
in interfaceDataTypeComponent
- Returns:
- the length of this component
-
getOrdinal
public int getOrdinal()
Description copied from interface:DataTypeComponent
Get the ordinal position within the parent dataType.- Specified by:
getOrdinal
in interfaceDataTypeComponent
- Returns:
- ordinal of this component within the parent data type.
-
getDefaultSettings
public Settings getDefaultSettings()
Description copied from interface:DataTypeComponent
Gets the default settings for this data type component.- Specified by:
getDefaultSettings
in interfaceDataTypeComponent
- Returns:
- a Settings object that is the set of default values for this dataType component
-
setDefaultSettings
public void setDefaultSettings(Settings settings)
Description copied from interface:DataTypeComponent
Set default settings for this dataType.- Specified by:
setDefaultSettings
in interfaceDataTypeComponent
- Parameters:
settings
- the new default settings.
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
isEquivalent
public boolean isEquivalent(DataTypeComponent dtc)
Description copied from interface:DataTypeComponent
Returns true if the given dataTypeComponent is equivalent to this dataTypeComponent. A dataTypeComponent is "equivalent" if the other component has a data type that is equivalent to this component's data type. The dataTypeComponents must also have the same offset, field name, and comment. The length is only checked for components which are dyanmic and whose size must be specified when creating a component.- Specified by:
isEquivalent
in interfaceDataTypeComponent
- Parameters:
dtc
- the dataTypeComponent being tested for equivalence.- Returns:
- true if the given dataTypeComponent is equivalent to this dataTypeComponent.
-
-