public abstract class VCSExtension extends java.lang.Object implements VCS, ShutdownHook
Abstract superclass for a version control system extension.
Modifier | Constructor and Description |
---|---|
protected |
VCSExtension(java.lang.String id) |
Modifier and Type | Method and Description |
---|---|
boolean |
canCheckOut(java.net.URL url)
Asks whether the given URL can be checked out through the version control
system.
|
boolean |
canShutdown()
Called on shutdown hooks in the order they were registered prior to
shutting down the IDE.
|
java.lang.String |
getCheckOutCommand()
Gets the 'check out Node' command provider classname for the VCS.
|
int |
getControlPrecedence()
Gets a value for the precedence of the extension in the control order for
any given URL.
|
VCSExceptionHandler |
getExceptionHandler()
Get the exception handler used to report errors for the VCS.
|
VCSHistoryGraphProvider |
getHistoryGraphProvider()
Gets the provider for the version history graph associated with a versioning system.
|
VCSHistoryProvider |
getHistoryProvider()
Gets the provider for the version history associated with a file.
|
java.lang.String |
getId()
Gets the identifying string used to uniquely represent the version control
system implementation
|
VCSExtensionInformation |
getInformation()
Gets displayable information used to represent the VCS extension in the
user interface.
|
oracle.jdeveloper.vcs.cache.StatusCache<VCSStatus> |
getPolicyStatusCache()
Gets the policy status cache for the VCS extension.
|
VCSStatus[] |
getStatus(java.net.URL[] urls)
Gets version control statuses for the given URLs.
|
VCSStatusCache |
getStatusCache()
Deprecated.
replaced by
getStatusCacheBridge() and getPolicyStatusCache() . |
oracle.jdeveloper.vcs.cache.StatusCacheBridge<VCSStatus> |
getStatusCacheBridge() |
URLFilter |
getURLFilter()
Gets a URLFilter for the type of files this VCS extension handles.
|
java.lang.String |
getVersionName(java.net.URL url)
Gets a name representing the current version of the given URL.
|
void |
initialize() |
void |
initializeEx() |
protected abstract void |
initializeImpl() |
boolean |
isConflictsStatus(java.net.URL url)
Asks whether the given status indicates that diff3-style merge conflicts
are present in the file.
|
boolean |
isConflictsStatus(VCSStatus status)
Asks whether the given status indicates that diff3-style merge conflicts
are present in the file.
|
abstract boolean |
isControlled(java.net.URL url)
Asks whether the given URL is controlled by the version control client.
|
boolean |
setReadWrite(java.net.URL url)
Deprecated.
replaced by
setReadWrite(URL[],VCSProgress) . |
boolean |
setReadWrite(java.net.URL[] urls)
Deprecated.
replaced by
setReadWrite(URL[],VCSProgress) . |
boolean |
setReadWrite(java.net.URL[] urls,
VCSProgress progress)
Sets the attributes of the given URLs to read/write through an appropriate
VCS operation.
|
void |
shutdown()
Called on all shutdown hooks in the order they were registered when the
IDE is terminating.
|
public final java.lang.String getId()
public abstract boolean isControlled(java.net.URL url)
url
- the URL.public int getControlPrecedence()
2
. Override this method to
return a higher number (in order to reduce the precedence) where you wish
the framework to recognize URLs as being controlled by other VCS extensions
before this one. The technique of reducing precedence is also useful for
relatively slow implementations of isControlled(URL)
, so as to
minimize impact on the overall performance of control evaluation.public final VCSStatus[] getStatus(java.net.URL[] urls) throws java.lang.Exception
urls
- an array of URLs for the status query.java.lang.Exception
- if a critical exception occurred.public VCSExceptionHandler getExceptionHandler()
VCSExceptionHandler
instance is
created and returned.@Deprecated public VCSStatusCache getStatusCache()
getStatusCacheBridge()
and getPolicyStatusCache()
.null
.public oracle.jdeveloper.vcs.cache.StatusCache<VCSStatus> getPolicyStatusCache()
null
.public oracle.jdeveloper.vcs.cache.StatusCacheBridge<VCSStatus> getStatusCacheBridge()
public URLFilter getURLFilter()
null
.public VCSExtensionInformation getInformation()
VCSExtensionInformation
is created
and returned based on the extension's classname.public VCSHistoryProvider getHistoryProvider()
null
.public VCSHistoryGraphProvider getHistoryGraphProvider()
null
.public boolean canCheckOut(java.net.URL url) throws java.lang.Exception
true
if the file is both read-only
and versioned.url
- the URL to test.java.lang.Exception
@Deprecated public boolean setReadWrite(java.net.URL url) throws java.lang.Exception
setReadWrite(URL[],VCSProgress)
.UnsupportedOperationException
.
URL is already read/write.url
- the URL to set read/write.true
if the URL was successfully set read/write.java.lang.Exception
- if a critical exception occurred.@Deprecated public boolean setReadWrite(java.net.URL[] urls) throws java.lang.Exception
setReadWrite(URL[],VCSProgress)
.UnsupportedOperationException
.urls
- the URLs to set read/write.true
if the URLs was successfully set read/write.java.lang.Exception
- if a critical exception occurred.public boolean setReadWrite(java.net.URL[] urls, VCSProgress progress) throws java.lang.Exception
setReadWrite(URL[])
.urls
- the URLs to set read/write.progress
- an object representing the progress of the wider operation.
The progress value associated with this object should be incremented by
1 per processed URL.true
if the URLs was successfully set read/write.java.lang.Exception
- if a critical exception occurred.public java.lang.String getCheckOutCommand()
null
. The provider class is usually of type
VCSCheckOutNodeCmd
, but this is not a
requirement.public java.lang.String getVersionName(java.net.URL url)
public boolean isConflictsStatus(VCSStatus status)
status
- the status.java.lang.Exception
- if a critical exception occurred.public boolean isConflictsStatus(java.net.URL url)
url
- the url.java.lang.Exception
- if a critical exception occurred.public final void initialize()
public final void initializeEx()
protected abstract void initializeImpl()
public boolean canShutdown()
canShutdown
in interface ShutdownHook
public void shutdown()
shutdown
in interface ShutdownHook