Package ghidra.framework.main.datatree

Class CheckInTask

java.lang.Object

ghidra.util.task.Task

ghidra.framework.main.datatree.VersionControlTask

ghidra.framework.main.datatree.CheckInTask

All Implemented Interfaces:

CheckinHandler, MonitoredRunnable

public class CheckInTask
extends VersionControlTask
implements CheckinHandler

Task to perform a check on a list of DomainFiles.

Field Summary

Fields inherited from class ghidra.framework.main.datatree.VersionControlTask

actionID, comments, createKeep, filesInUse, keepCheckedOut, list, parent, tool, wasCanceled

Fields inherited from class ghidra.util.task.Task

taskMonitor, waitForTaskCompleted

Constructor Summary

Constructors

Constructor	Description
CheckInTask(PluginTool tool, java.util.List<DomainFile> list, java.awt.Component parent)	Construct a new CheckInTask.

Method Summary

Modifier and Type	Method	Description
boolean	createKeepFile()	Returns true if the system should create a keep file copy of the user's check-in file.
java.lang.String	getComment()	Returns the check-in comment.
boolean	keepCheckedOut()	Returns true if check-out state should be retained.
void	run(TaskMonitor myMonitor)	This is the method that will be called to do the work

Methods inherited from class ghidra.framework.main.datatree.VersionControlTask

checkFilesForUnsavedChanges, checkFilesInUse, showDialog

Methods inherited from class ghidra.util.task.Task

addTaskListener, canCancel, cancel, getStatusTextAlignment, getTaskTitle, getWaitForTaskCompleted, hasProgress, isCancelled, isModal, monitoredRun, notifyTaskListeners, setHasProgress

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckInTask

public CheckInTask(PluginTool tool,
                   java.util.List<DomainFile> list,
                   java.awt.Component parent)

Construct a new CheckInTask.

Parameters:

tool - tool that has the files to be checked in

list - list of domain files to be checked in

parent - parent of error dialog if an error occurs

Method Detail

run

public void run(TaskMonitor myMonitor)

Description copied from class: Task

This is the method that will be called to do the work

Note: The run(TaskMonitor) method should not make any calls directly on Swing components, as these calls are not thread safe. Place Swing calls in a Runnable, then call Swing.runLater(Runnable) or Swing.runNow(Runnable)to schedule the Runnable inside of the AWT Event Thread.

Specified by:

run in class Task

Parameters:

myMonitor - The TaskMonitor that will monitor the executing Task

getComment

public java.lang.String getComment()
                            throws CancelledException

Description copied from interface: CheckinHandler

Returns the check-in comment.

Specified by:

getComment in interface CheckinHandler

Returns:

the check-in comment

Throws:

CancelledException - thrown if user cancels the check-in

keepCheckedOut

public boolean keepCheckedOut()
                       throws CancelledException

Description copied from interface: CheckinHandler

Returns true if check-out state should be retained.

Specified by:

keepCheckedOut in interface CheckinHandler

Returns:

true if check-out state should be retained

Throws:

CancelledException - thrown if user cancels the check-in

createKeepFile

public boolean createKeepFile()
                       throws CancelledException

Description copied from interface: CheckinHandler

Returns true if the system should create a keep file copy of the user's check-in file.

Specified by:

createKeepFile in interface CheckinHandler

Throws:

CancelledException - thrown if user cancels the check-in