Extension SDK 9.0.5

oracle.jdeveloper.vcs.spi
Class VCSAbstractExtension

java.lang.Object
  extended byoracle.jdeveloper.vcs.spi.VCSAbstractExtension
All Implemented Interfaces:
Addin, Extension, Module, VCS, VCSExtension

public abstract class VCSAbstractExtension
extends java.lang.Object
implements VCSExtension

Abstract superclass for a version control system extension.

Since:
9.0.5

Field Summary
static java.lang.String VCS_EXTENSION_GROUP_DATA_KEY
           
 
Fields inherited from interface oracle.ide.vcs.VCS
COMMAND_VCS_ADD, COMMAND_VCS_CHECK_OUT, COMMAND_VCS_CHECK_OUT_DOCUMENT, COMMAND_VCS_REMOVE
 
Constructor Summary
VCSAbstractExtension()
           
 
Method Summary
 boolean canDeInitialize()
          Enables the extension to inform the extension manager that it can't be de-initialized (dynamically unloaded).
 boolean canInitialize()
          Can the extension be initialized
 boolean canShutdown()
          This method is invoked by the AddinManager before the IDE terminates.
 void deInitialize()
          Invoked by the AddinManager when the extension is to be de-initialized (dynamically unloaded).
protected abstract  void deInitializeExtension()
           
 VCSStatus[] getStatus(java.net.URL[] urls)
          Gets version control statuses for the given URLs.
protected abstract  VCSStatus[] getStatusImpl(java.net.URL[] urls)
          Gets version control statuses for the given URLs (implementation).
 URLFilter getURLFilter()
          Get a URLFilter for the type of files this version control extension handles.
 float ideVersion()
          This method is called to determine the ide version number for which this Addin was implemented.
 void initialize()
          Invoked by the AddinManager after the instance of the Addin is instantiated.
protected abstract  void initializeExtension()
           
 void shutdown()
          This method is invoked by the AddinManager when the IDE terminates.
 float version()
          This method is called to determine the Addin version number.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface oracle.ide.vcs.VCS
getCommand
 

Field Detail

VCS_EXTENSION_GROUP_DATA_KEY

public static final java.lang.String VCS_EXTENSION_GROUP_DATA_KEY
See Also:
Constant Field Values
Constructor Detail

VCSAbstractExtension

public VCSAbstractExtension()
Method Detail

getStatus

public VCSStatus[] getStatus(java.net.URL[] urls)
                      throws java.lang.Exception
Description copied from interface: VCS
Gets version control statuses for the given URLs. This method may be called concurrently from different threads.

Specified by:
getStatus in interface VCS
Parameters:
urls - an array of URLs for the status query.
Returns:
the resulting array of statuses, corresponding by index.
Throws:
java.lang.Exception - if a critical exception occurred.

initialize

public void initialize()
Description copied from interface: Addin
Invoked by the AddinManager after the instance of the Addin is instantiated. When invoked, The Addin should register and menu items, and actions required for use during this classes lifecycle. Addin authors should take care to ensure that any extraneous initialization is not preformed on this method, and any startup code that can be delayed until a later time is delayed, as the Addin's are synchronously initialized during the startup of the IDE, and each Addin has the potential to negatively impact the startup time of the product.

Specified by:
initialize in interface Addin
See Also:
AddinManager

shutdown

public void shutdown()
Description copied from interface: Addin
This method is invoked by the AddinManager when the IDE terminates. Any non java resources (file handles, database connections, etc) which are still being held by this Addin should be released by this method immediately. This method is not guaranteed to be called, but on normal terminations of the IDE, this method will be invoked.

Specified by:
shutdown in interface Addin

version

public float version()
Description copied from interface: Addin
This method is called to determine the Addin version number.

Specified by:
version in interface Addin
Returns:
the version number.

ideVersion

public float ideVersion()
Description copied from interface: Addin
This method is called to determine the ide version number for which this Addin was implemented.

Specified by:
ideVersion in interface Addin
Returns:
the ide version number.

canShutdown

public boolean canShutdown()
Description copied from interface: Addin
This method is invoked by the AddinManager before the IDE terminates. Addins should NOT use this method to release resources. They should only use this method to give users the opportunity to cancel the exit process if there is some process started by this addin still running. Implementations should return false to cancel the shutdown process.

Specified by:
canShutdown in interface Addin

canInitialize

public boolean canInitialize()
Description copied from interface: Extension
Can the extension be initialized

Specified by:
canInitialize in interface Extension
Returns:
trueif the extension can be initialized; false if the extension can't be initialized

deInitialize

public void deInitialize()
Description copied from interface: Extension
Invoked by the AddinManager when the extension is to be de-initialized (dynamically unloaded). When invoked, the Extension should de-register menu items etc.

Specified by:
deInitialize in interface Extension

canDeInitialize

public boolean canDeInitialize()
Description copied from interface: Extension
Enables the extension to inform the extension manager that it can't be de-initialized (dynamically unloaded).

Specified by:
canDeInitialize in interface Extension
Returns:
true if the extension can be de-initialized (dynamically unloaded) false if the extension can't be de-initialized (dynamically unloaded).

initializeExtension

protected abstract void initializeExtension()

deInitializeExtension

protected abstract void deInitializeExtension()

getStatusImpl

protected abstract VCSStatus[] getStatusImpl(java.net.URL[] urls)
                                      throws java.lang.Exception
Gets version control statuses for the given URLs (implementation). This method may be called concurrently from different threads.

Parameters:
urls - an array of URLs for the status query.
Returns:
the resulting array of statuses, corresponding by index.
Throws:
java.lang.Exception - if a critical exception occurred.

getURLFilter

public URLFilter getURLFilter()
Description copied from interface: VCSExtension
Get a URLFilter for the type of files this version control extension handles.

Specified by:
getURLFilter in interface VCSExtension
Returns:

Extension SDK

 

Copyright © 1997, 2004, Oracle. All rights reserved.