Package ghidra.framework.main.datatree

Class VersionControlTask

java.lang.Object

ghidra.util.task.Task

ghidra.framework.main.datatree.VersionControlTask

All Implemented Interfaces:

MonitoredRunnable

Direct Known Subclasses:

CheckInTask

public abstract class VersionControlTask
extends Task

Task to show a dialog to enter comments for checking in a file

Field Summary

Fields

Change	Modifier and Type	Field	Description
NEW	protected int	actionID
NEW	protected java.lang.String	comments
NEW	protected boolean	createKeep
NEW	protected boolean	filesInUse
NEW	protected boolean	keepCheckedOut
NEW	protected java.util.List<DomainFile>	list
NEW	protected java.awt.Component	parent
NEW	protected PluginTool	tool
NEW	protected boolean	wasCanceled

Fields inherited from class ghidra.util.task.Task

waitForTaskCompleted

Constructor Summary

Constructors

Change	Modifier	Constructor	Description
	protected	VersionControlTask(java.lang.String title, PluginTool tool, java.util.List<DomainFile> list, java.awt.Component parent)	Constructor

Method Summary

Change	Modifier and Type	Method	Description
NEW	protected boolean	checkFilesForUnsavedChanges()
NEW	protected void	checkFilesInUse()	Sets the filesInUse field if any file is in use.
NEW	protected void	showDialog(boolean addToVersionControl, java.lang.String filename)	Show the dialog.

Methods inherited from class ghidra.util.task.Task

addTaskListener, canCancel, cancel, getStatusTextAlignment, getTaskTitle, hasProgress, isForgettable, isInterruptible, isModal, monitoredRun, notifyTaskListeners, run, setForgettable, setHasProgress, setInterruptible

Methods inherited from class java.lang.Object

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

Field Detail

list NEW

protected java.util.List<DomainFile> list

actionID NEW

protected int actionID

keepCheckedOut NEW

protected boolean keepCheckedOut

createKeep NEW

protected boolean createKeep

comments NEW

protected java.lang.String comments

filesInUse NEW

protected boolean filesInUse

tool NEW

protected PluginTool tool

wasCanceled NEW

protected boolean wasCanceled

parent NEW

protected java.awt.Component parent

Constructor Detail

VersionControlTask

protected VersionControlTask(java.lang.String title,
                             PluginTool tool,
                             java.util.List<DomainFile> list,
                             java.awt.Component parent)

Constructor

Parameters:

title - title of the task

tool - tool associated with the task

list - list of domain files

parent - parent of the version control dialog; may be null

Method Detail

showDialog NEW

protected void showDialog(boolean addToVersionControl,
                          java.lang.String filename)

Show the dialog.

Parameters:

addToVersionControl - true if the dialog is for adding files to version control, false for checking in files.

filename - the name of the file currently to be added, whose comment we need.

checkFilesInUse NEW

protected void checkFilesInUse()

Sets the filesInUse field if any file is in use. Call this method from the run() method so that the "Keep checked out" checkbox on the dialog is disabled if files are still in use.

checkFilesForUnsavedChanges NEW

protected boolean checkFilesForUnsavedChanges()