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
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
ConstructorDescriptionCheckInTask
(PluginTool tool, List<DomainFile> list, Component parent) Construct a new CheckInTask. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns true if the system should create a keep file copy of the user's check-in file.Returns the check-in comment.boolean
Returns true if check-out state should be retained.void
run
(TaskMonitor myMonitor) This is the method that will be called to do the workMethods 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
-
Constructor Details
-
CheckInTask
Construct a new CheckInTask.- Parameters:
tool
- tool that has the files to be checked inlist
- list of domain files to be checked inparent
- parent of error dialog if an error occurs
-
-
Method Details
-
run
Description copied from class:Task
This is the method that will be called to do the workNote: 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)
orSwing.runNow(Runnable)
to schedule the Runnable inside of the AWT Event Thread. -
getComment
Description copied from interface:CheckinHandler
Returns the check-in comment.- Specified by:
getComment
in interfaceCheckinHandler
- Returns:
- the check-in comment
- Throws:
CancelledException
- thrown if user cancels the check-in
-
keepCheckedOut
Description copied from interface:CheckinHandler
Returns true if check-out state should be retained.- Specified by:
keepCheckedOut
in interfaceCheckinHandler
- Returns:
- true if check-out state should be retained
- Throws:
CancelledException
- thrown if user cancels the check-in
-
createKeepFile
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 interfaceCheckinHandler
- Throws:
CancelledException
- thrown if user cancels the check-in
-