Interface DataTypeReferenceFinder

  • All Superinterfaces:
    ExtensionPoint

    public interface DataTypeReferenceFinder
    extends ExtensionPoint
    An interface for extension points to implement. Implementations know how to find data type references.

    Implementation class names must end with DataTypeReferenceFinder

    • Method Detail

      • findReferences

        void findReferences​(Program program,
                            DataType dataType,
                            java.util.function.Consumer<DataTypeReference> callback,
                            TaskMonitor monitor)
                     throws CancelledException
        Finds references in the current program in a manner appropriate with the given implementation.

        Note that this operation is multi-threaded and that results will be delivered as they are found via the callback.

        Parameters:
        program - the program to search
        dataType - the type for which to search
        callback - the callback to be called when a reference is found
        monitor - the monitor that allows for progress and cancellation
        Throws:
        CancelledException - if the operation was cancelled
      • findReferences

        void findReferences​(Program program,
                            Composite composite,
                            java.lang.String fieldName,
                            java.util.function.Consumer<DataTypeReference> callback,
                            TaskMonitor monitor)
                     throws CancelledException
        Finds references in the current program to specific field of the given Composite type in a manner appropriate with the given implementation.

        Note that this operation is multi-threaded and that results will be delivered as they are found via the callback.

        Parameters:
        program - the program to search
        composite - the type containing the field for which to search
        fieldName - the name of the composite's field for which to search
        callback - the callback to be called when a reference is found
        monitor - the monitor that allows for progress and cancellation
        Throws:
        CancelledException - if the operation was cancelled