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 booleanequals(java.lang.Object obj)java.lang.StringgetComment()Get the comment for this dataTypeComponent.DataTypegetDataType()Returns the dataType in this component.java.lang.StringgetDefaultFieldName()Returns a default Field name.SettingsgetDefaultSettings()Gets the default settings for this data type component.intgetEndOffset()Get the byte offset of where this component ends relative to the start of the parent data type.java.lang.StringgetFieldName()Get the name of the field name as a component of a Data Type.intgetLength()Get the length of this component.intgetOffset()Get the byte offset of where this component begins relative to the start of the parent data type.intgetOrdinal()Get the ordinal position within the parent dataType.DataTypegetParent()returns the dataType that contains this component.booleanisEquivalent(DataTypeComponent dtc)Returns true if the given dataTypeComponent is equivalent to this dataTypeComponent.booleanisFlexibleArrayComponent()Determine if this component corresponds to a unsized flexible array which is permitted as the trailing component within a structure.voidsetComment(java.lang.String comment)Sets the comment for the component.voidsetDefaultSettings(Settings settings)Set default settings for this dataType.voidsetFieldName(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
-
isFlexibleArrayComponent
public boolean isFlexibleArrayComponent()
Description copied from interface:DataTypeComponentDetermine if this component corresponds to a unsized flexible array which is permitted as the trailing component within a structure.- Specified by:
isFlexibleArrayComponentin interfaceDataTypeComponent- Returns:
- true if component is a trailing flexible array component.
-
getOffset
public int getOffset()
Description copied from interface:DataTypeComponentGet the byte offset of where this component begins relative to the start of the parent data type.NOTE: The special case of a structure flexible array component returns an offset equal to the length of the parent structure since the flexible array component is not included in a structure's length.
- Specified by:
getOffsetin interfaceDataTypeComponent- Returns:
- offset of start of component relative to the start of the parent data type.
- See Also:
DataTypeComponent.getOffset()
-
getEndOffset
public int getEndOffset()
Description copied from interface:DataTypeComponentGet the byte offset of where this component ends relative to the start of the parent data type.NOTE: The special case of a structure flexible array component returns -1 since its length is undefined.
- Specified by:
getEndOffsetin interfaceDataTypeComponent- Returns:
- offset of end of component relative to the start of the parent data type.
- See Also:
DataTypeComponent.getEndOffset()
-
getComment
public java.lang.String getComment()
Description copied from interface:DataTypeComponentGet the comment for this dataTypeComponent.- Specified by:
getCommentin interfaceDataTypeComponent- See Also:
DataTypeComponent.getComment()
-
setComment
public void setComment(java.lang.String comment)
Description copied from interface:DataTypeComponentSets the comment for the component.- Specified by:
setCommentin interfaceDataTypeComponent- Parameters:
comment- this components comment.- See Also:
DataTypeComponent.setComment(java.lang.String)
-
getFieldName
public java.lang.String getFieldName()
Description copied from interface:DataTypeComponentGet the name of the field name as a component of a Data Type.- Specified by:
getFieldNamein interfaceDataTypeComponent- Returns:
- the name as a component of another Data Type.
- See Also:
DataTypeComponent.getFieldName()
-
getDefaultFieldName
public java.lang.String getDefaultFieldName()
Description copied from interface:DataTypeComponentReturns a default Field name. Used only if a field name is not set.- Specified by:
getDefaultFieldNamein interfaceDataTypeComponent- See Also:
DataTypeComponent.getDefaultFieldName()
-
setFieldName
public void setFieldName(java.lang.String fieldName) throws DuplicateNameExceptionDescription copied from interface:DataTypeComponentSets 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:
setFieldNamein interfaceDataTypeComponent- Parameters:
fieldName- the new field name for this component.- Throws:
DuplicateNameException- if another component of the parent has the specified field name.- See Also:
DataTypeComponent.setFieldName(java.lang.String)
-
getDataType
public DataType getDataType()
Description copied from interface:DataTypeComponentReturns the dataType in this component.NOTE: If this component corresponds to a structure flexible array the returned data type reflects the base type of the array (e.g., char is returned for a flexible char array).
- Specified by:
getDataTypein interfaceDataTypeComponent- Returns:
- the dataType in this component
- See Also:
DataTypeComponent.getDataType()
-
getParent
public DataType getParent()
Description copied from interface:DataTypeComponentreturns the dataType that contains this component.- Specified by:
getParentin interfaceDataTypeComponent- Returns:
- the dataType that contains this component.
- See Also:
DataTypeComponent.getParent()
-
getLength
public int getLength()
Description copied from interface:DataTypeComponentGet the length of this component.NOTE: The special case of a structure flexible array component returns 0 since its length is undefined.
- Specified by:
getLengthin interfaceDataTypeComponent- Returns:
- the length of this component or 0 for a structure flexible array.
- See Also:
DataTypeComponent.getLength()
-
getOrdinal
public int getOrdinal()
Description copied from interface:DataTypeComponentGet the ordinal position within the parent dataType.NOTE: The special case of a structure flexible array component returns an ordinal equal to the parent structure's
Structure.getNumComponents()since it is not included in the list of normal components (seeStructure.getFlexibleArrayComponent().- Specified by:
getOrdinalin interfaceDataTypeComponent- Returns:
- ordinal of this component within the parent data type.
- See Also:
DataTypeComponent.getOrdinal()
-
getDefaultSettings
public Settings getDefaultSettings()
Description copied from interface:DataTypeComponentGets the default settings for this data type component.- Specified by:
getDefaultSettingsin interfaceDataTypeComponent- Returns:
- a Settings object that is the set of default values for this dataType component
- See Also:
DataTypeComponent.getDefaultSettings()
-
setDefaultSettings
public void setDefaultSettings(Settings settings)
Description copied from interface:DataTypeComponentSet default settings for this dataType.- Specified by:
setDefaultSettingsin interfaceDataTypeComponent- Parameters:
settings- the new default settings.- See Also:
DataTypeComponent.setDefaultSettings(ghidra.docking.settings.Settings)
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object- See Also:
Object.equals(java.lang.Object)
-
isEquivalent
public boolean isEquivalent(DataTypeComponent dtc)
Description copied from interface:DataTypeComponentReturns 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, length, ordinal, field name, and comment.- Specified by:
isEquivalentin interfaceDataTypeComponent- Parameters:
dtc- the dataTypeComponent being tested for equivalence.- Returns:
- true if the given dataTypeComponent is equivalent to this dataTypeComponent.
-
-