Class 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
    • 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 isFlexibleArrayComponent()
      Determine if this component corresponds to a unsized flexible array which is permitted as the trailing component within a structure.
      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.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • 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 component
        parent - the dataType that this component belongs to
        length - the length of the dataType in this component.
        offset - the byte offset within the parent
        ordinal - the index of this component in the parent.
        fieldName - the name associated with this component
        comment - 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 component
        parent - the dataType that this component belongs to
        length - the length of the dataType in this component.
        ordinal - the index of this component in the parent.
        offset - the byte offset within the parent