Package ghidra.framework.data

Interface DomainObjectMergeManager

All Superinterfaces:

MergeProgressModifier

All Known Implementing Classes:

DataTypeArchiveMergeManager, MergeManager, ProgramMultiUserMergeManager

public interface DomainObjectMergeManager
extends MergeProgressModifier

An interface to allow merging of domain objects.

Method Summary

Modifier and Type	Method	Description
void	clearStatusText()	Clear the status text on the merge dialog.
boolean	merge(TaskMonitor monitor)	Merge domain objects and resolve any conflicts.
void	setApplyEnabled(boolean enabled)	Enable the apply button according to the "enabled" parameter.
void	setResolveInformation(java.lang.String infoType, java.lang.Object infoObject)	Sets the resolve information object for the indicated standardized name.
void	setStatusText(java.lang.String msg)	Set the status text on the merge dialog.
void	showComponent(javax.swing.JComponent comp, java.lang.String componentID, HelpLocation helpLoc)	Show the component that is used to resolve conflicts.

Methods inherited from interface ghidra.app.merge.MergeProgressModifier

setCompleted, setInProgress, updateProgress, updateProgress, updateProgress

Method Detail

merge

boolean merge(TaskMonitor monitor)
       throws CancelledException

Merge domain objects and resolve any conflicts.

Returns:

true if the merge process completed successfully

Throws:

CancelledException - if the user canceled the merge process

setResolveInformation

void setResolveInformation(java.lang.String infoType,
                           java.lang.Object infoObject)

Sets the resolve information object for the indicated standardized name. This is how information is passed between merge managers.

Parameters:

infoType - the string indicating the type of resolve information

infoObject - the object for the named string. This information is determined by the merge manager that creates it.

See Also:

MergeManager.getResolveInformation(String)

showComponent

void showComponent(javax.swing.JComponent comp,
                   java.lang.String componentID,
                   HelpLocation helpLoc)

Show the component that is used to resolve conflicts. This method is called by the MergeResolvers when user input is required. If the component is not null, this method blocks until the user either cancels the merge process or resolves a conflict. If comp is null, then the default component is displayed, and the method does not wait for user input.

Parameters:

comp - component to show; if component is null, show the default component and do not block

componentID - id or name for the component

setApplyEnabled

void setApplyEnabled(boolean enabled)

Enable the apply button according to the "enabled" parameter.

clearStatusText

void clearStatusText()

Clear the status text on the merge dialog.

setStatusText

void setStatusText(java.lang.String msg)

Set the status text on the merge dialog.