VersionControlAction

java.lang.Object
- docking.action.DockingAction
- - ghidra.framework.main.datatable.DomainFileProviderContextAction
  - - ghidra.framework.main.projectdata.actions.VersionControlAction

All Implemented Interfaces:

DockingActionIf, HelpDescriptor

Direct Known Subclasses:

VersionControlAddAction, VersionControlCheckInAction, VersionControlCheckOutAction, VersionControlDataTypeArchiveUndoCheckoutAction, VersionControlShowHistoryAction, VersionControlUndoCheckOutAction, VersionControlUndoHijackAction, VersionControlUpdateAction, VersionControlViewCheckOutAction
```
public abstract class VersionControlAction
extends DomainFileProviderContextAction
```
VersionControlAction is an abstract class that can be extended by each specific version control action to be taken on a domain file.

Field Summary

Fields
Modifier and Type Field Description

protected static java.lang.String GROUP

protected RepositoryAdapter repository

protected PluginTool tool
- Fields inherited from interface docking.action.DockingActionIf
  DESCRIPTION_PROPERTY, ENABLEMENT_PROPERTY, GLOBALCONTEXT_PROPERTY, KEYBINDING_DATA_PROPERTY, MENUBAR_DATA_PROPERTY, POPUP_MENU_DATA_PROPERTY, TOOLBAR_DATA_PROPERTY

Constructor Summary

Constructors
Constructor Description

VersionControlAction(java.lang.String name, java.lang.String owner, PluginTool tool)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`checkRepositoryConnected()`	NOTE: do not call this from a non-Swing thread.
`boolean`	`isAddToPopup(DomainFileContext context)`	Returns true if there is at least one of the provided domain files can be or is version controlled.
`protected boolean`	`isFileSystemBusy()`	True if the file system is locked by another thread for a long running operation

Methods inherited from class ghidra.framework.main.datatable.DomainFileProviderContextAction
actionPerformed, actionPerformed, isAddToPopup, isEnabledForContext, isEnabledForContext, isValidContext, isValidContext

Methods inherited from class docking.action.DockingAction
addPropertyChangeListener, addToWindowWhen, createButton, createMenuItem, dispose, doCreateButton, doCreateMenuItem, enabledWhen, firePropertyChanged, getDefaultKeyBindingData, getDescription, getFullName, getHelpInfo, getHelpObject, getInceptionFromTheFirstClassThatIsNotUsOrABuilder, getInceptionInformation, getKeyBinding, getKeyBindingData, getKeyBindingType, getMenuBarData, getName, getOwner, getPopupMenuData, getPreferredKeyBindingType, getToolBarData, isEnabled, markHelpUnnecessary, popupWhen, removePropertyChangeListener, setAddToAllWindows, setDescription, setEnabled, setHelpLocation, setKeyBindingData, setMenuBarData, setPopupMenuData, setSupportsDefaultToolContext, setToolBarData, setUnvalidatedKeyBindingData, shouldAddToWindow, supportsDefaultToolContext, toString, validContextWhen

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface docking.action.DockingActionIf
getOwnerDescription

- Field Detail
  - GROUP
```
protected static final java.lang.String GROUP
```
    See Also:
    
    Constant Field Values
  - tool
```
protected PluginTool tool
```
  - repository
```
protected RepositoryAdapter repository
```
- Constructor Detail
  - VersionControlAction
```
public VersionControlAction(java.lang.String name,
                            java.lang.String owner,
                            PluginTool tool)
```
- Method Detail
  - isAddToPopup
```
public boolean isAddToPopup(DomainFileContext context)
```
    Returns true if there is at least one of the provided domain files can be or is version controlled.
    
    Overrides:
    
    isAddToPopup in class DomainFileProviderContextAction
  - isFileSystemBusy
```
protected boolean isFileSystemBusy()
```
    True if the file system is locked by another thread for a long running operation
    
    Returns:
    
    true if locked
  - checkRepositoryConnected
```
protected boolean checkRepositoryConnected()
```
    NOTE: do not call this from a non-Swing thread.
    
    Returns:
    
    true if the repository is null or is connected.