Package ghidra.program.model.data

# Class UnionDataType

java.lang.Object
ghidra.program.model.data.AbstractDataType
ghidra.program.model.data.DataTypeImpl
ghidra.program.model.data.GenericDataType
ghidra.program.model.data.CompositeDataTypeImpl
ghidra.program.model.data.UnionDataType

All Implemented Interfaces:
  `Composite`, `CompositeInternal`, `DataType`, `Union`, `UnionInternal`

public class UnionDataType extends CompositeDataTypeImpl implements UnionInternal
Basic implementation of the union data type. NOTE: Implementation is not thread safe when being modified.

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from interface ghidra.program.model.data.CompositeInternal

  `CompositeInternal.ComponentComparator, CompositeInternal.OffsetComparator, CompositeInternal.OrdinalComparator`

- ## Field Summary

  ### Fields inherited from class ghidra.program.model.data.CompositeDataTypeImpl

  `minimumAlignment, packing`

  ### Fields inherited from class ghidra.program.model.data.DataTypeImpl

  `defaultSettings`

  ### Fields inherited from class ghidra.program.model.data.AbstractDataType

  `categoryPath, dataMgr, name`

  ### Fields inherited from interface ghidra.program.model.data.CompositeInternal

  `ALIGN_NAME, DEFAULT_ALIGNMENT, DEFAULT_PACKING, DEFAULT_PACKING_NAME, DISABLED_PACKING_NAME, MACHINE_ALIGNMENT, NO_PACKING, PACKING_NAME`

  ### Fields inherited from interface ghidra.program.model.data.DataType

  `CONFLICT_SUFFIX, DEFAULT, NO_LAST_CHANGE_TIME, NO_SOURCE_SYNC_TIME, TYPEDEF_ATTRIBUTE_PREFIX, TYPEDEF_ATTRIBUTE_SUFFIX, VOID`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `UnionDataType(CategoryPath path, String name)`
  Construct a new empty union with the given name within the specified categry path.
  `UnionDataType(CategoryPath path, String name, DataTypeManager dtm)`
  Construct a new empty union with the given name and datatype manager within the specified categry path.
  `UnionDataType(CategoryPath path, String name, UniversalID universalID, SourceArchive sourceArchive, long lastChangeTime, long lastChangeTimeInSourceArchive, DataTypeManager dtm)`
  Construct a new empty union with the given name within the specified categry path.
  `UnionDataType(String name)`
  Construct a new UnionDataType.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `DataTypeComponent`
  `add(DataType dataType, int length, String componentName, String comment)`
  Adds a new datatype to the end of this composite.
  `DataTypeComponent`
  `addBitField(DataType baseDataType, int bitSize, String componentName, String comment)`
  Adds a new bitfield to the end of this composite.
  `Union`
  `clone(DataTypeManager dtm)`
  Returns an instance of this DataType using the specified `DataTypeManager` to allow its use of the corresponding `DataOrganization` while retaining its unique identity (see `DataType.getUniversalID()` and archive association (see `DataType.getSourceArchive()`) if applicable.
  `DataType`
  `copy(DataTypeManager dtm)`
  Returns a new instance (shallow copy) of this DataType with a new identity and no source archive association.
  `void`
  `dataTypeAlignmentChanged(DataType dt)`
  Notification that the given datatype's alignment has changed.
  `void`
  `dataTypeDeleted(DataType dt)`
  Informs this datatype that the given datatype has been deleted.
  `void`
  `dataTypeReplaced(DataType oldDt, DataType newDt)`
  Informs this datatype that the given oldDT has been replaced with newDT
  `void`
  `dataTypeSizeChanged(DataType dt)`
  Notification that the given datatype's size has changed.
  `void`
  `delete(int ordinal)`
  Deletes the component at the given ordinal position.
  `void`
  `delete(Set<Integer> ordinals)`
  Deletes the specified set of components at the given ordinal positions.
  `boolean`
  `dependsOn(DataType dt)`
  Check if this datatype depends on the existence of the given datatype.
  `int`
  `getAlignment()`
  Gets the alignment to be used when aligning this datatype within another datatype.
  `DataTypeComponent`
  `getComponent(int ordinal)`
  Returns the component of this data type with the indicated ordinal.
  `DataTypeComponent[]`
  `getComponents()`
  Returns an array of Data Type Components that make up this composite including undefined filler components which may be present within a Structure which has packing disabled.
  `String`
  `getDefaultLabelPrefix()`
  Returns the appropriate string to use as the default label prefix in the absence of any data.
  `DataTypeComponent[]`
  `getDefinedComponents()`
  Returns an array of Data Type Components that make up this composite excluding undefined filler components which may be present within Structures where packing is disabled.
  `int`
  `getLength()`
  Get the length of this DataType as a number of 8-bit bytes.
  `int`
  `getNumComponents()`
  Gets the number of component data types in this composite.
  `int`
  `getNumDefinedComponents()`
  Returns the number of explicitly defined components in this composite.
  `String`
  `getRepresentation(MemBuffer buf, Settings settings, int length)`
  Get bytes from memory in a printable format for this type.
  `boolean`
  `hasLanguageDependantLength()`
  Indicates if the length of this data-type is determined based upon the `DataOrganization` obtained from the associated `DataTypeManager`.
  `DataTypeComponent`
  `insert(int ordinal, DataType dataType, int length, String componentName, String comment)`
  Inserts a new datatype at the specified ordinal position in this composite.
  `DataTypeComponent`
  `insertBitField(int ordinal, DataType baseDataType, int bitSize, String componentName, String comment)`
  Inserts a new bitfield at the specified ordinal position in this union.
  `boolean`
  `isEquivalent(DataType dt)`
  Check if the given datatype is equivalent to this datatype.
  `boolean`
  `isZeroLength()`
  Indicates this datatype is defined with a zero length.
  `boolean`
  `repack(boolean notify)`
  Repack components within this composite based on the current packing, alignment and `DataOrganization` settings.
  `void`
  `replaceWith(DataType dataType)`
  For datatypes that support change, this method replaces the internals of this datatype with the internals of the given datatype.

  ### Methods inherited from class ghidra.program.model.data.CompositeDataTypeImpl

  `add, add, add, checkAncestry, dataTypeNameChanged, getAlignedLength, getAlignmentType, getDescription, getExplicitMinimumAlignment, getExplicitPackingValue, getMnemonic, getNonPackedAlignment, getPackingType, getPreferredComponentLength, getPreferredComponentLength, getStoredMinimumAlignment, getStoredPackingValue, getValue, insert, insert, isNotYetDefined, isPartOf, repack, setDescription, setExplicitMinimumAlignment, setExplicitPackingValue, setName, setPackingEnabled, setToDefaultAligned, setToDefaultPacking, setToMachineAligned, setValue, toString, updateBitFieldDataType, validateDataType`

  ### Methods inherited from class ghidra.program.model.data.GenericDataType

  `setCategoryPath, setNameAndCategory`

  ### Methods inherited from class ghidra.program.model.data.DataTypeImpl

  `addParent, equals, getDefaultSettings, getLastChangeTime, getLastChangeTimeInSourceArchive, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getUniversalID, getValueClass, hashCode, notifyAlignmentChanged, notifyDeleted, notifyNameChanged, notifyParents, notifyReplaced, notifySizeChanged, removeParent, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive`

  ### Methods inherited from class ghidra.program.model.data.AbstractDataType

  `encodeRepresentation, encodeValue, getCategoryPath, getDataOrganization, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getName, getTypeDefSettingsDefinitions, isDeleted, isEncodable`

  ### Methods inherited from class java.lang.Object

  `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

  ### Methods inherited from interface ghidra.program.model.data.Composite

  `add, add, add, align, getAlignmentType, getExplicitMinimumAlignment, getExplicitPackingValue, getPackingType, hasDefaultPacking, hasExplicitMinimumAlignment, hasExplicitPackingValue, insert, insert, isDefaultAligned, isMachineAligned, isPackingEnabled, isPartOf, pack, repack, setDescription, setExplicitMinimumAlignment, setExplicitPackingValue, setPackingEnabled, setToDefaultAligned, setToDefaultPacking, setToMachineAligned`

  ### Methods inherited from interface ghidra.program.model.data.CompositeInternal

  `getStoredMinimumAlignment, getStoredPackingValue`

  ### Methods inherited from interface ghidra.program.model.data.DataType

  `addParent, dataTypeNameChanged, encodeRepresentation, encodeValue, getAlignedLength, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDescription, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getMnemonic, getName, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getTypeDefSettingsDefinitions, getUniversalID, getValue, getValueClass, isDeleted, isEncodable, isNotYetDefined, removeParent, setCategoryPath, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive`

- ## Constructor Details

  - ### UnionDataType

    public UnionDataType(CategoryPath path, String name)
    Construct a new empty union with the given name within the specified categry path. An empty union will report its length as 1 and `CompositeDataTypeImpl.isNotYetDefined()` will return true. NOTE: A constructor form which accepts a `DataTypeManager` should be used when possible since there may be performance benefits during datatype resolution.
    Parameters:
      `path` - the category path indicating where this data type is located.
      `name` - the name of the new union

  - ### UnionDataType

    public UnionDataType(CategoryPath path, String name, DataTypeManager dtm)
    Construct a new empty union with the given name and datatype manager within the specified categry path. An empty union will report its length as 1 and `CompositeDataTypeImpl.isNotYetDefined()` will return true.
    Parameters:
      `path` - the category path indicating where this data type is located.
      `name` - the name of the new union
      `dtm` - the data type manager associated with this data type. This can be null. Also, the data type manager may not yet contain this actual data type.

  - ### UnionDataType

    public UnionDataType(CategoryPath path, String name, UniversalID universalID, SourceArchive sourceArchive, long lastChangeTime, long lastChangeTimeInSourceArchive, DataTypeManager dtm)
    Construct a new empty union with the given name within the specified categry path. An empty union will report its length as 1 and `CompositeDataTypeImpl.isNotYetDefined()` will return true.
    Parameters:
      `path` - the category path indicating where this data type is located.
      `name` - the name of the new structure
      `universalID` - the id for the data type
      `sourceArchive` - the source archive for this data type
      `lastChangeTime` - the last time this data type was changed
      `lastChangeTimeInSourceArchive` - the last time this data type was changed in its source archive.
      `dtm` - the data type manager associated with this data type. This can be null. Also, the data type manager may not contain this actual data type.

  - ### UnionDataType

    public UnionDataType(String name)
    Construct a new UnionDataType. NOTE: A constructor form which accepts a `DataTypeManager` should be used when possible since there may be performance benefits during datatype resolution.
    Parameters:
      `name` - the name of this dataType

- ## Method Details

  - ### getRepresentation

    public String getRepresentation(MemBuffer buf, Settings settings, int length)
    Description copied from interface: `DataType`
    Get bytes from memory in a printable format for this type.
    Specified by:
      `getRepresentation` in interface `DataType`
    Parameters:
      `buf` - the data.
      `settings` - the settings to use for the representation.
      `length` - the number of bytes to represent.
    Returns:
      the representation of the data in this format, never null.

  - ### getComponent

    public DataTypeComponent getComponent(int ordinal)
    Description copied from interface: `Composite`
    Returns the component of this data type with the indicated ordinal.
    Specified by:
      `getComponent` in interface `Composite`
    Parameters:
      `ordinal` - the component's ordinal (zero based).
    Returns:
      the data type component.

  - ### getComponents

    public DataTypeComponent[] getComponents()
    Description copied from interface: `Composite`
    Returns an array of Data Type Components that make up this composite including undefined filler components which may be present within a Structure which has packing disabled. The number of components corresponds to `Composite.getNumComponents()`.
    Specified by:
      `getComponents` in interface `Composite`
    Returns:
      array all components

  - ### getDefinedComponents

    public DataTypeComponent[] getDefinedComponents()
    Description copied from interface: `Composite`
    Returns an array of Data Type Components that make up this composite excluding undefined filler components which may be present within Structures where packing is disabled. The number of components corresponds to `Composite.getNumDefinedComponents()`. For Unions and packed Structures this is equivalent to `Composite.getComponents()` since they do not contain undefined filler components.
    Specified by:
      `getDefinedComponents` in interface `Composite`
    Returns:
      array all explicitly defined components

  - ### getNumComponents

    public int getNumComponents()
    Description copied from interface: `Composite`
    Gets the number of component data types in this composite. If this is Structure with packing disabled, the count will include all undefined filler components which may be present.
    Specified by:
      `getNumComponents` in interface `Composite`
    Returns:
      the number of components that make up this composite

  - ### getNumDefinedComponents

    public int getNumDefinedComponents()
    Description copied from interface: `Composite`
    Returns the number of explicitly defined components in this composite. For Unions and packed Structures this is equivalent to `Composite.getNumComponents()` since they do not contain undefined components. This count will always exclude all undefined filler components which may be present within a Structure whose packing is disabled (see `Composite.isPackingEnabled()`).
    Specified by:
      `getNumDefinedComponents` in interface `Composite`
    Returns:
      the number of explicitly defined components in this composite

  - ### add

    public DataTypeComponent add(DataType dataType, int length, String componentName, String comment) throws IllegalArgumentException
    Description copied from interface: `Composite`
    Adds a new datatype to the end of this composite. This is the preferred method to use for adding components to an aligned structure for dynamic dataTypes such as strings whose length must be specified.
    Specified by:
      `add` in interface `Composite`
    Parameters:
      `dataType` - the datatype to add.
      `length` - the length to associate with the datatype. For fixed length types a length <= 0 will use the length of the resolved dataType.
      `componentName` - the field name to associate with this component.
      `comment` - the comment to associate with this component.
    Returns:
      the componentDataType created.
    Throws:
      `IllegalArgumentException` - if the specified data type is not allowed to be added to this composite data type or an invalid length is specified. For example, suppose dt1 contains dt2. Therefore it is not valid to add dt1 to dt2 since this would cause a cyclic dependency.

  - ### insert

    public DataTypeComponent insert(int ordinal, DataType dataType, int length, String componentName, String comment) throws IllegalArgumentException
    Description copied from interface: `Composite`
    Inserts a new datatype at the specified ordinal position in this composite.
    Note: For an aligned structure the ordinal position will get adjusted automatically to provide the proper alignment.
    Specified by:
      `insert` in interface `Composite`
    Parameters:
      `ordinal` - the ordinal where the new datatype is to be inserted.
      `dataType` - the datatype to insert.
      `length` - the length to associate with the datatype. For fixed length types a length <= 0 will use the length of the resolved dataType.
      `componentName` - the field name to associate with this component.
      `comment` - the comment to associate with this component.
    Returns:
      the componentDataType created.
    Throws:
      `IllegalArgumentException` - if the specified data type is not allowed to be inserted into this composite data type or an invalid length is specified. For example, suppose dt1 contains dt2. Therefore it is not valid to insert dt1 to dt2 since this would cause a cyclic dependency.

  - ### addBitField

    public DataTypeComponent addBitField(DataType baseDataType, int bitSize, String componentName, String comment) throws InvalidDataTypeException
    Description copied from interface: `Composite`
    Adds a new bitfield to the end of this composite. This method is intended to be used with packed structures/unions only where the bitfield will be appropriately packed. The minimum storage storage byte size will be applied. It will not provide useful results for composites with packing disabled.
    Specified by:
      `addBitField` in interface `Composite`
    Parameters:
      `baseDataType` - the bitfield base datatype (certain restrictions apply).
      `bitSize` - the bitfield size in bits
      `componentName` - the field name to associate with this component.
      `comment` - the comment to associate with this component.
    Returns:
      the componentDataType created whose associated data type will be BitFieldDataType.
    Throws:
      `InvalidDataTypeException` - if the specified data type is not a valid base type for bitfields.

  - ### insertBitField

    public DataTypeComponent insertBitField(int ordinal, DataType baseDataType, int bitSize, String componentName, String comment) throws InvalidDataTypeException, IndexOutOfBoundsException
    Description copied from interface: `Union`
    Inserts a new bitfield at the specified ordinal position in this union. For all Unions, bitfield starts with bit-0 (lsb) of the first byte for little-endian, and with bit-7 (msb) of the first byte for big-endian. This is the default behavior for most compilers. Insertion behavior may not work as expected if packing rules differ from this.
    Specified by:
      `insertBitField` in interface `Union`
    Parameters:
      `ordinal` - the ordinal where the new datatype is to be inserted.
      `baseDataType` - the bitfield base datatype (certain restrictions apply).
      `bitSize` - the declared bitfield size in bits. The effective bit size may be adjusted based upon the specified baseDataType.
      `componentName` - the field name to associate with this component.
      `comment` - the comment to associate with this component.
    Returns:
      the bitfield component created whose associated data type will be BitFieldDataType.
    Throws:
      `InvalidDataTypeException` - if the specified baseDataType is not a valid base type for bitfields.
      `IndexOutOfBoundsException` - if ordinal is less than 0 or greater than the current number of components.

  - ### isZeroLength

    public boolean isZeroLength()
    Description copied from interface: `DataType`
    Indicates this datatype is defined with a zero length.

    This method should not be confused with `DataType.isNotYetDefined()` which indicates that nothing but the name and basic type is known.

    NOTE: a zero-length datatype must return a length of 1 via `DataType.getLength()`. Zero-length datatypes used as a component within a `Composite` may, or may not, be assigned a component length of 0. The method `DataTypeComponent.usesZeroLengthComponent(DataType)` is used to make this determination.

    Specified by:
      `isZeroLength` in interface `DataType`
    Overrides:
      `isZeroLength` in class `AbstractDataType`
    Returns:
      true if type definition has a length of 0, else false

  - ### getLength

    public int getLength()
    Description copied from interface: `DataType`
    Get the length of this DataType as a number of 8-bit bytes.

    For primitive datatypes this reflects the smallest varnode which can be used to contain its value (i.e., raw data length).

    Example: For x86 32-bit gcc an 80-bit `long double` `raw data length` of 10-bytes will fit within a floating point register while its `aligned-length` of 12-bytes is used by the gcc compiler for data/array/component allocations to maintain alignment (i.e., `sizeof(long double)` ).

    NOTE: Other than the `VoidDataType`, no datatype should ever return 0, even if `DataType.isZeroLength()`, and only `Dynamic`/`FactoryDataType` datatypes should return -1. If `DataType.isZeroLength()` is true a length of 1 should be returned. Where a zero-length datatype can be handled (e.g., `Composite`) the `DataType.isZeroLength()` method should be used.

    Specified by:
      `getLength` in interface `DataType`
    Returns:
      the length of this DataType

  - ### hasLanguageDependantLength

    public boolean hasLanguageDependantLength()
    Description copied from interface: `DataType`
    Indicates if the length of this data-type is determined based upon the `DataOrganization` obtained from the associated `DataTypeManager`.
    Specified by:
      `hasLanguageDependantLength` in interface `DataType`
    Specified by:
      `hasLanguageDependantLength` in class `CompositeDataTypeImpl`
    Returns:
      true length is language/compiler-specification dependent, else false

  - ### clone

    public Union clone(DataTypeManager dtm)
    Description copied from interface: `DataType`
    Returns an instance of this DataType using the specified `DataTypeManager` to allow its use of the corresponding `DataOrganization` while retaining its unique identity (see `DataType.getUniversalID()` and archive association (see `DataType.getSourceArchive()`) if applicable.

    This instance will be returned if this datatype's DataTypeManager matches the specified dtm. The recursion depth of a clone will stop on any datatype whose `DataTypeManager` matches the specified dtm and simply use the existing datatype instance.

    NOTE: In general, this method should not be used to obtain an instance to be modified. In most cases changes may be made directly to this instance if supported or to a `DataType.copy(DataTypeManager)` of this type.

    Specified by:
      `clone` in interface `DataType`
    Specified by:
      `clone` in interface `Union`
    Parameters:
      `dtm` - the data-type manager instance whose data-organization should apply.
    Returns:
      cloned instance which may be the same as this instance

  - ### copy

    public DataType copy(DataTypeManager dtm)
    Description copied from interface: `DataType`
    Returns a new instance (shallow copy) of this DataType with a new identity and no source archive association.

    Any reference to other datatypes will use `DataType.clone(DataTypeManager)`.

    Specified by:
      `copy` in interface `DataType`
    Parameters:
      `dtm` - the data-type manager instance whose data-organization should apply.
    Returns:
      new instanceof of this datatype

  - ### delete

    public void delete(int ordinal)
    Description copied from interface: `Composite`
    Deletes the component at the given ordinal position.
    Note: Removal of bitfields from a structure with packing disabled will not shift other components causing vacated bytes to revert to undefined filler.
    Specified by:
      `delete` in interface `Composite`
    Parameters:
      `ordinal` - the ordinal of the component to be deleted.

  - ### delete

    public void delete(Set<Integer> ordinals)
    Description copied from interface: `Composite`
    Deletes the specified set of components at the given ordinal positions.
    Note: Removal of bitfields from a structure with packing disabled will not shift other components causing vacated bytes to revert to undefined filler.
    Specified by:
      `delete` in interface `Composite`
    Parameters:
      `ordinals` - the ordinals of the component to be deleted.

  - ### getAlignment

    public int getAlignment()
    Description copied from interface: `DataType`
    Gets the alignment to be used when aligning this datatype within another datatype.
    Specified by:
      `getAlignment` in interface `Composite`
    Specified by:
      `getAlignment` in interface `DataType`
    Specified by:
      `getAlignment` in class `CompositeDataTypeImpl`
    Returns:
      this datatype's alignment.

  - ### repack

    public boolean repack(boolean notify)
    Description copied from class: `CompositeDataTypeImpl`
    Repack components within this composite based on the current packing, alignment and `DataOrganization` settings. Non-packed Structures: change detection is limited to component count and length is assumed to already be correct.

    NOTE: If modifications to stored length are made prior to invoking this method, detection of a size change may not be possible.

    NOTE: Currently a change in calculated alignment can not be provided since this value is not stored.

    Specified by:
      `repack` in class `CompositeDataTypeImpl`
    Parameters:
      `notify` - if true notification will be sent to parents if a size change or component placement change is detected.
    Returns:
      true if a layout change was detected.

  - ### isEquivalent

    public boolean isEquivalent(DataType dt)
    Description copied from interface: `DataType`
    Check if the given datatype is equivalent to this datatype.

    The precise meaning of "equivalent" is datatype dependent.
    NOTE: if invoked by a DB object or manager it should be invoked on the DataTypeDB object passing the other datatype as the argument.

    Specified by:
      `isEquivalent` in interface `DataType`
    Parameters:
      `dt` - the datatype being tested for equivalence.
    Returns:
      true if the if the given datatype is equivalent to this datatype.

  - ### dataTypeAlignmentChanged

    public void dataTypeAlignmentChanged(DataType dt)
    Description copied from interface: `DataType`
    Notification that the given datatype's alignment has changed.

    DataTypes may need to make internal changes in response.
    TODO: This method is reserved for internal DB use.

    Specified by:
      `dataTypeAlignmentChanged` in interface `Composite`
    Specified by:
      `dataTypeAlignmentChanged` in interface `DataType`
    Overrides:
      `dataTypeAlignmentChanged` in class `AbstractDataType`
    Parameters:
      `dt` - the datatype that has changed.

  - ### dataTypeSizeChanged

    public void dataTypeSizeChanged(DataType dt)
    Description copied from interface: `DataType`
    Notification that the given datatype's size has changed.

    DataTypes may need to make internal changes in response.
    TODO: This method is reserved for internal DB use.

    Specified by:
      `dataTypeSizeChanged` in interface `DataType`
    Overrides:
      `dataTypeSizeChanged` in class `AbstractDataType`
    Parameters:
      `dt` - the datatype that has changed.

  - ### dataTypeReplaced

    public void dataTypeReplaced(DataType oldDt, DataType newDt) throws IllegalArgumentException
    Description copied from interface: `DataType`
    Informs this datatype that the given oldDT has been replaced with newDT

    TODO: This method is reserved for internal DB use.

    Specified by:
      `dataTypeReplaced` in interface `DataType`
    Overrides:
      `dataTypeReplaced` in class `AbstractDataType`
    Parameters:
      `oldDt` - old datatype
      `newDt` - new datatype
    Throws:
      `IllegalArgumentException`

  - ### dataTypeDeleted

    public void dataTypeDeleted(DataType dt)
    Description copied from interface: `DataType`
    Informs this datatype that the given datatype has been deleted.

    TODO: This method is reserved for internal DB use.

    Specified by:
      `dataTypeDeleted` in interface `DataType`
    Overrides:
      `dataTypeDeleted` in class `AbstractDataType`
    Parameters:
      `dt` - the datatype that has been deleted.

  - ### replaceWith

    public void replaceWith(DataType dataType) throws IllegalArgumentException
    Description copied from interface: `DataType`
    For datatypes that support change, this method replaces the internals of this datatype with the internals of the given datatype.

    The datatypes must be of the same "type" (i.e. structure can only be replacedWith another structure.

    Specified by:
      `replaceWith` in interface `DataType`
    Overrides:
      `replaceWith` in class `DataTypeImpl`
    Parameters:
      `dataType` - the datatype that contains the internals to upgrade to.
    Throws:
      `IllegalArgumentException` - if the given datatype is not the same type as this datatype.

  - ### dependsOn

    public boolean dependsOn(DataType dt)
    Description copied from interface: `DataType`
    Check if this datatype depends on the existence of the given datatype.

    For example byte[] depends on byte. If byte were deleted, then byte[] would also be deleted.

    Specified by:
      `dependsOn` in interface `DataType`
    Overrides:
      `dependsOn` in class `AbstractDataType`
    Parameters:
      `dt` - the datatype to test that this datatype depends on.
    Returns:
      true if the existence of this datatype relies on the existence of the specified datatype dt.

  - ### getDefaultLabelPrefix

    public String getDefaultLabelPrefix()
    Description copied from interface: `DataType`
    Returns the appropriate string to use as the default label prefix in the absence of any data.
    Specified by:
      `getDefaultLabelPrefix` in interface `DataType`
    Overrides:
      `getDefaultLabelPrefix` in class `AbstractDataType`
    Returns:
      the default label prefix or null if none specified.