Package ghidra.app.plugin.debug

Class DomainFolderChangesDisplayPlugin

java.lang.Object

ghidra.framework.plugintool.Plugin

ghidra.app.plugin.debug.DomainFolderChangesDisplayPlugin

All Implemented Interfaces:

ApplicationLevelOnlyPlugin, ApplicationLevelPlugin, DomainFolderChangeListener, ProjectListener, PluginEventListener, ServiceListener, ExtensionPoint

public class DomainFolderChangesDisplayPlugin
extends Plugin
implements ApplicationLevelOnlyPlugin, ProjectListener, DomainFolderChangeListener

Field Summary

Fields inherited from class ghidra.framework.plugintool.Plugin

name, pluginDescription, tool

Constructor Summary

Constructors

Constructor	Description
DomainFolderChangesDisplayPlugin(PluginTool tool)

Method Summary

Modifier and Type	Method	Description
protected void	dispose()	Tells a plugin that it is no longer needed.
void	domainFileAdded(DomainFile file)	Notification that a file is added to parent folder.
void	domainFileMoved(DomainFile file, DomainFolder oldParent, String oldName)	Notification that the domain file was moved.
void	domainFileObjectClosed(DomainFile file, DomainObject object)	Notification that a domain file previously open for update is in the process of closing.
void	domainFileObjectOpenedForUpdate(DomainFile file, DomainObject object)	Notification that a domain file has been opened for update.
void	domainFileRemoved(DomainFolder parent, String folderName, String fileID)	Notification that a file was removed
void	domainFileRenamed(DomainFile file, String oldName)	Notification that the domain file was renamed.
void	domainFileStatusChanged(DomainFile file, boolean fileIDset)	Notification that the status for a domain file has changed.
void	domainFolderAdded(DomainFolder folder)	Notification that a folder is added to parent.
void	domainFolderMoved(DomainFolder folder, DomainFolder oldParent)	Notification that the domain folder was moved.
void	domainFolderRemoved(DomainFolder parent, String folderName)	Notification that a domain folder is removed.
void	domainFolderRenamed(DomainFolder folder, String oldName)	Notify listeners when a domain folder is renamed.
void	domainFolderSetActive(DomainFolder folder)	Notification that the setActive() method on the folder was called.
protected void	init()	Initialization method; override to add initialization for this plugin.
void	projectClosed(Project project)	Notification that the given project is closed.
void	projectOpened(Project project)	Notification that the given project is open.
void	serviceAdded(Class<?> interfaceClass, Object service)	Notifies this plugin that a service has been added to the plugin tool.
void	serviceRemoved(Class<?> interfaceClass, Object service)	Notifies this plugin that service has been removed from the plugin tool.

Methods inherited from class ghidra.framework.plugintool.Plugin

accept, acceptData, canClose, canCloseDomainObject, cleanup, close, dataStateRestoreCompleted, dependsUpon, deregisterService, equals, eventSent, firePluginEvent, getData, getMissingRequiredServices, getName, getPluginDescription, getServicesRequired, getSupportedDataTypes, getTool, getTransientState, getUndoRedoState, hashCode, hasMissingRequiredService, hasUnsaveData, internalRegisterEventConsumed, isDisposed, prepareToSave, processEvent, readConfigState, readDataState, registerDynamicServiceProvided, registerServiceProvided, restoreTransientState, restoreUndoRedoState, saveData, writeConfigState, writeDataState

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DomainFolderChangesDisplayPlugin

public DomainFolderChangesDisplayPlugin(PluginTool tool)

Method Details

serviceRemoved

public void serviceRemoved(Class<?> interfaceClass,
 Object service)

Description copied from class: Plugin

Notifies this plugin that service has been removed from the plugin tool. Plugins should override this method if they update their state when a particular service is removed.

Specified by:

serviceRemoved in interface ServiceListener

Overrides:

serviceRemoved in class Plugin

Parameters:

interfaceClass - The interface of the added service

service - that is being removed.

serviceAdded

public void serviceAdded(Class<?> interfaceClass,
 Object service)

Description copied from class: Plugin

Notifies this plugin that a service has been added to the plugin tool. Plugins should override this method if they update their state when a particular service is added.

Specified by:

serviceAdded in interface ServiceListener

Overrides:

serviceAdded in class Plugin

Parameters:

interfaceClass - The interface of the added service

service - service that is being added

init

protected void init()

Description copied from class: Plugin

Initialization method; override to add initialization for this plugin. This is where a plugin should acquire its services. When this method is called, all plugins have been instantiated in the tool.

Overrides:

init in class Plugin

dispose

protected void dispose()

Description copied from class: Plugin

Tells a plugin that it is no longer needed. The plugin should release any resources that it has. All actions, components, services will automatically be cleaned up.

Overrides:

dispose in class Plugin

projectOpened

public void projectOpened(Project project)

Description copied from interface: ProjectListener

Notification that the given project is open.

Specified by:

projectOpened in interface ProjectListener

Parameters:

project - project that is opened

projectClosed

public void projectClosed(Project project)

Description copied from interface: ProjectListener

Notification that the given project is closed.

Specified by:

projectClosed in interface ProjectListener

Parameters:

project - project that is closed

domainFolderAdded

public void domainFolderAdded(DomainFolder folder)

Description copied from interface: DomainFolderChangeListener

Notification that a folder is added to parent.

Specified by:

domainFolderAdded in interface DomainFolderChangeListener

Parameters:

folder - domain folder which was just added.

domainFileAdded

public void domainFileAdded(DomainFile file)

Description copied from interface: DomainFolderChangeListener

Notification that a file is added to parent folder. You can get the parent from the file.

Specified by:

domainFileAdded in interface DomainFolderChangeListener

Parameters:

file - domain file which was just added.

domainFolderRemoved

public void domainFolderRemoved(DomainFolder parent,
 String folderName)

Description copied from interface: DomainFolderChangeListener

Notification that a domain folder is removed.

Specified by:

domainFolderRemoved in interface DomainFolderChangeListener

Parameters:

parent - domain folder which contained the folder that was just removed.

folderName - the name of the folder that was removed.

domainFileRemoved

public void domainFileRemoved(DomainFolder parent,
 String folderName,
 String fileID)

Description copied from interface: DomainFolderChangeListener

Notification that a file was removed

Specified by:

domainFileRemoved in interface DomainFolderChangeListener

Parameters:

parent - domain folder which contained the file that was just removed.

folderName - the name of the file that was removed.

fileID - file ID or null

domainFolderRenamed

public void domainFolderRenamed(DomainFolder folder,
 String oldName)

Description copied from interface: DomainFolderChangeListener

Notify listeners when a domain folder is renamed.

Specified by:

domainFolderRenamed in interface DomainFolderChangeListener

Parameters:

folder - folder that was renamed

oldName - old name of folder

domainFileRenamed

public void domainFileRenamed(DomainFile file,
 String oldName)

Description copied from interface: DomainFolderChangeListener

Notification that the domain file was renamed.

Specified by:

domainFileRenamed in interface DomainFolderChangeListener

Parameters:

file - file that was renamed

oldName - old name of the file

domainFolderMoved

public void domainFolderMoved(DomainFolder folder,
 DomainFolder oldParent)

Description copied from interface: DomainFolderChangeListener

Notification that the domain folder was moved.

Specified by:

domainFolderMoved in interface DomainFolderChangeListener

Parameters:

folder - the folder (after move)

oldParent - original parent folder

domainFileMoved

public void domainFileMoved(DomainFile file,
 DomainFolder oldParent,
 String oldName)

Description copied from interface: DomainFolderChangeListener

Notification that the domain file was moved.

Specified by:

domainFileMoved in interface DomainFolderChangeListener

Parameters:

file - the file (after move)

oldParent - original parent folder

oldName - file name prior to move

domainFolderSetActive

public void domainFolderSetActive(DomainFolder folder)

Description copied from interface: DomainFolderChangeListener

Notification that the setActive() method on the folder was called.

Specified by:

domainFolderSetActive in interface DomainFolderChangeListener

Parameters:

folder - folder which was activated/visited

domainFileStatusChanged

public void domainFileStatusChanged(DomainFile file,
 boolean fileIDset)

Description copied from interface: DomainFolderChangeListener

Notification that the status for a domain file has changed.

Specified by:

domainFileStatusChanged in interface DomainFolderChangeListener

Parameters:

file - file whose status has changed.

fileIDset - if true indicates that the previously missing fileID has been established for the specified file.

domainFileObjectOpenedForUpdate

public void domainFileObjectOpenedForUpdate(DomainFile file,
 DomainObject object)

Description copied from interface: DomainFolderChangeListener

Notification that a domain file has been opened for update.

Specified by:

domainFileObjectOpenedForUpdate in interface DomainFolderChangeListener

Parameters:

file - domain file

object - domain object open for update

domainFileObjectClosed

public void domainFileObjectClosed(DomainFile file,
 DomainObject object)

Description copied from interface: DomainFolderChangeListener

Notification that a domain file previously open for update is in the process of closing.

Specified by:

domainFileObjectClosed in interface DomainFolderChangeListener

Parameters:

file - domain file

object - domain object which was open for update