public abstract class VersioningSystem extends Object
ServiceProvider
.VersioningSystem.Registration
. (recommended) Modifier and Type | Class and Description |
---|---|
static interface |
VersioningSystem.Registration
Register a VersioningSystem in the IDE.
|
Modifier and Type | Field and Description |
---|---|
static String |
PROP_DISPLAY_NAME
Short name of the versioning system, it will be used as popup menu label, label in tooltips, etc.
|
static String |
PROP_LOCALHISTORY_VCS
Marker property for a Versioning system that operates in Local History mode.
|
static String |
PROP_MENU_LABEL
Short name of the versioning system, it will be used as menu label and it should define a mnemonic key.
|
Modifier | Constructor and Description |
---|---|
protected |
VersioningSystem()
Protected constructor, does nothing.
|
Modifier and Type | Method and Description |
---|---|
void |
addPropertyChangeListener(PropertyChangeListener listener)
Adds a listener for change events.
|
protected void |
fireAnnotationsChanged(Set<File> files)
Helper method to signal that annotations of a set of files changed.
|
protected void |
fireStatusChanged(File file)
Helper method that calls fireStatusChanged(Collections.singleton(file)).
|
protected void |
fireStatusChanged(Set<File> files)
Helper method to signal that status of a set of files changed.
|
protected void |
fireVersionedFilesChanged()
Helper method to signal that the versioning system started to manage some previously unversioned files
(those files were imported into repository).
|
CollocationQueryImplementation |
getCollocationQueryImplementation()
Retrieves a CollocationQueryImplementation if this versioning system provides one.
|
void |
getOriginalFile(File workingCopy,
File originalFile)
Get the original (unmodified) copy of a file.
|
Object |
getProperty(String key)
Gets a general property of a Versioning system.
|
File |
getTopmostManagedAncestor(File file)
Tests whether the file is managed by this versioning system.
|
VCSAnnotator |
getVCSAnnotator()
Retrieves a VCSAnnotator implementation if this versioning system provides one.
|
VCSHistoryProvider |
getVCSHistoryProvider()
Retrieves a VCSHistoryProvider implementation if this versioning system provides one.
|
VCSInterceptor |
getVCSInterceptor()
Retrieves a VCSInterceptor implementation if this versioning system provides one.
|
VCSVisibilityQuery |
getVisibilityQuery()
Retrieves a VCSVisibilityQuery implementation if this versioning system provides one.
|
protected void |
putProperty(String key,
Object value)
Sets a general property of a Versioning system.
|
void |
removePropertyChangeListener(PropertyChangeListener listener)
Removes a listener for change events.
|
public static final String PROP_DISPLAY_NAME
public static final String PROP_MENU_LABEL
public static final String PROP_LOCALHISTORY_VCS
protected VersioningSystem()
public final Object getProperty(String key)
key
- property keyVersioningSystem.PROP_DISPLAY_NAME
,
VersioningSystem.PROP_MENU_LABEL
protected final void putProperty(String key, Object value)
key
- property key, must NOT be nullvalue
- property value, may be nullVersioningSystem.PROP_DISPLAY_NAME
,
VersioningSystem.PROP_MENU_LABEL
public File getTopmostManagedAncestor(File file)
file
- a filepublic VCSAnnotator getVCSAnnotator()
public VCSInterceptor getVCSInterceptor()
public VCSHistoryProvider getVCSHistoryProvider()
public void getOriginalFile(File workingCopy, File originalFile)
workingCopy
- a File in the working copyoriginalFile
- placeholder File for the original (unmodified) copy of the working filepublic CollocationQueryImplementation getCollocationQueryImplementation()
public VCSVisibilityQuery getVisibilityQuery()
public final void addPropertyChangeListener(PropertyChangeListener listener)
listener
- a PropertyChangeListenerpublic final void removePropertyChangeListener(PropertyChangeListener listener)
listener
- a PropertyChangeListenerprotected final void fireAnnotationsChanged(Set<File> files)
files
- set of files whose annotations changed or null if the change affects all filesprotected final void fireStatusChanged(Set<File> files)
files
- set of files whose status changed or null if all files changed statusprotected final void fireVersionedFilesChanged()
protected final void fireStatusChanged(File file)
file
- a file whose status changedVersioningSystem.fireStatusChanged(java.util.Set)