com.esri.arcgis.system
Class ExtensionManager

java.lang.Object
  extended by com.esri.arcgis.system.ExtensionManager
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IExtensionManager, IExtensionManagerAdmin, IJITExtensionManager, ISupportErrorInfo, java.io.Serializable

public class ExtensionManager
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IExtensionManager, IExtensionManagerAdmin, ISupportErrorInfo, IJITExtensionManager

COM Class 'ExtensionManager'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriSystem.olb'

Description 'Extension Manager - a singleton.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.system.IExtensionManager
IID, IID05c71634_d9d5_4d6f_b68e_d7661142fa06, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IExtensionManagerAdmin
IID, IID262c00f9_114d_45f8_bc9d_a0dd208dc9e1, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IJITExtensionManager
IID, IID0e3b4663_4ca5_4638_aa4a_7d89878209e5, xxDummy
 
Constructor Summary
ExtensionManager()
          Constructs a ExtensionManager using ArcGIS Engine.
ExtensionManager(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ExtensionManager theExtensionManager = (ExtensionManager) obj;
 
Method Summary
 void addExtension(IUID extensionCLSID, java.lang.Object initializationData)
          Creates a single extension given the CLSID, then passes initializationData to IExtension::Startup.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IExtension findExtension(java.lang.Object nameOrID)
          Finds the extension by CLSID (IUID) or name (String).
static java.lang.String getClsid()
          getClsid.
 IExtension getExtension(int index)
          The extension at the specified index.
 IUID getExtensionCLSID(int index)
          The CLSID of the extension at the specified index.
 int getExtensionCount()
          The number of extensions loaded in the application.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IUID getJITExtensionCLSID(int index)
          Retrieves the CLSID of the JIT Extension at index.
 int getJITExtensionCount()
          The number of just in time extensions registered with the application.
 int hashCode()
          the hashcode for this object
 void insertExtension(IUID pExtCLSID, IExtension pExtension)
          Adds an extension to the manager without initialization.
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isExtensionEnabled(IUID pExtCLSID)
          Indicates whether the extension is currently checked on.
 boolean isLoaded(IUID pID)
          Indicates whether the extension is currently loaded.
 void release()
          Release a ExtensionManager.
 void removeExtension(IExtension pExtension)
          Removes a just in time extension from the manager.
 void shutdownExtensions()
          Shuts down and releases the extensions that are loaded and calls IExtension::Shutdown.
 void startupExtensions(IUID componentCategory, IUID jitCategory, java.lang.Object initializationData)
          Creates and starts the extensions for the given component category, passing initializationData to each in IExtension::Startup.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExtensionManager

public ExtensionManager()
                 throws java.io.IOException,
                        java.net.UnknownHostException
Constructs a ExtensionManager using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

ExtensionManager

public ExtensionManager(java.lang.Object obj)
                 throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ExtensionManager theExtensionManager = (ExtensionManager) obj;

Construct a ExtensionManager using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ExtensionManager.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a ExtensionManager.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getExtensionCount

public int getExtensionCount()
                      throws java.io.IOException,
                             AutomationException
The number of extensions loaded in the application.

Specified by:
getExtensionCount in interface IExtensionManager
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtension

public IExtension getExtension(int index)
                        throws java.io.IOException,
                               AutomationException
The extension at the specified index.

Specified by:
getExtension in interface IExtensionManager
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.system.IExtension
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensionCLSID

public IUID getExtensionCLSID(int index)
                       throws java.io.IOException,
                              AutomationException
The CLSID of the extension at the specified index.

Specified by:
getExtensionCLSID in interface IExtensionManager
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findExtension

public IExtension findExtension(java.lang.Object nameOrID)
                         throws java.io.IOException,
                                AutomationException
Finds the extension by CLSID (IUID) or name (String).

Specified by:
findExtension in interface IExtensionManager
Parameters:
nameOrID - A Variant (in)
Returns:
A reference to a com.esri.arcgis.system.IExtension
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startupExtensions

public void startupExtensions(IUID componentCategory,
                              IUID jitCategory,
                              java.lang.Object initializationData)
                       throws java.io.IOException,
                              AutomationException
Creates and starts the extensions for the given component category, passing initializationData to each in IExtension::Startup.

Specified by:
startupExtensions in interface IExtensionManagerAdmin
Parameters:
componentCategory - A reference to a com.esri.arcgis.system.IUID (in)
jitCategory - A reference to a com.esri.arcgis.system.IUID (in)
initializationData - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

shutdownExtensions

public void shutdownExtensions()
                        throws java.io.IOException,
                               AutomationException
Shuts down and releases the extensions that are loaded and calls IExtension::Shutdown.

Specified by:
shutdownExtensions in interface IExtensionManagerAdmin
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addExtension

public void addExtension(IUID extensionCLSID,
                         java.lang.Object initializationData)
                  throws java.io.IOException,
                         AutomationException
Creates a single extension given the CLSID, then passes initializationData to IExtension::Startup.

Specified by:
addExtension in interface IExtensionManagerAdmin
Parameters:
extensionCLSID - A reference to a com.esri.arcgis.system.IUID (in)
initializationData - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getJITExtensionCount

public int getJITExtensionCount()
                         throws java.io.IOException,
                                AutomationException
The number of just in time extensions registered with the application.

Specified by:
getJITExtensionCount in interface IJITExtensionManager
Returns:
The pCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getJITExtensionCLSID

public IUID getJITExtensionCLSID(int index)
                          throws java.io.IOException,
                                 AutomationException
Retrieves the CLSID of the JIT Extension at index.

Specified by:
getJITExtensionCLSID in interface IJITExtensionManager
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLoaded

public boolean isLoaded(IUID pID)
                 throws java.io.IOException,
                        AutomationException
Indicates whether the extension is currently loaded.

Specified by:
isLoaded in interface IJITExtensionManager
Parameters:
pID - A reference to a com.esri.arcgis.system.IUID (in)
Returns:
The bLoaded
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeExtension

public void removeExtension(IExtension pExtension)
                     throws java.io.IOException,
                            AutomationException
Removes a just in time extension from the manager.

Specified by:
removeExtension in interface IJITExtensionManager
Parameters:
pExtension - A reference to a com.esri.arcgis.system.IExtension (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertExtension

public void insertExtension(IUID pExtCLSID,
                            IExtension pExtension)
                     throws java.io.IOException,
                            AutomationException
Adds an extension to the manager without initialization.

Specified by:
insertExtension in interface IJITExtensionManager
Parameters:
pExtCLSID - A reference to a com.esri.arcgis.system.IUID (in)
pExtension - A reference to a com.esri.arcgis.system.IExtension (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isExtensionEnabled

public boolean isExtensionEnabled(IUID pExtCLSID)
                           throws java.io.IOException,
                                  AutomationException
Indicates whether the extension is currently checked on.

Specified by:
isExtensionEnabled in interface IJITExtensionManager
Parameters:
pExtCLSID - A reference to a com.esri.arcgis.system.IUID (in)
Returns:
The enabled
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.