javax.ide.extension
Interface Extension

All Superinterfaces:

Identifiable

public interface Extension

extends Identifiable

Information gathered from the Extension Deployment Descriptor is stored by implementations of this interface. Such information include the extension's id, owner, version information, etc.

Method Summary

URIPath	getClassPath() Get an additional classpath where classes used by this extension can be found.
java.util.Collection	getDependencies() Gets a collection of ExtensionDependency objects, one for each dependency this extension has on another extension.
Version	getEDKVersion() This method is called by an IDE to inquire about the version of the Extenstion Development Kit (EDK) used in its implementation.
java.lang.String	getName() Get the name of this extension.
java.lang.String	getOwner() Get the extension owner name.
PlatformInfo	getPlatformInfo() This method is called by an IDE to inquire about platform specific information that must be supported by the IDE for this extension to work.
Version	getVersion() Get the extension version information.

Methods inherited from interface javax.ide.Identifiable

getID

Method Detail

getName

public java.lang.String getName()

Get the name of this extension. The name should not include the extension version label.

Returns:

A short name for this extension.

getOwner

public java.lang.String getOwner()

Get the extension owner name.

Returns:

A label identifying the extension writer.

getVersion

public Version getVersion()

Get the extension version information.

Returns:

A the extension version specification.

getEDKVersion

public Version getEDKVersion()

This method is called by an IDE to inquire about the version of the Extenstion Development Kit (EDK) used in its implementation. An IDE can decide not to load this extension if they don't yet support the EDK version returned. If null is returned, the IDE will not load the extension.

Returns:

The version of the EDK used to implement this extension.

getPlatformInfo

public PlatformInfo getPlatformInfo()

This method is called by an IDE to inquire about platform specific information that must be supported by the IDE for this extension to work. For example, the extension platform information may indicate the it requires swing to work.

getDependencies

public java.util.Collection getDependencies()

Gets a collection of ExtensionDependency objects, one for each dependency this extension has on another extension.

Returns:

a collection of ExtensionDependency objects. May be empty.

getClassPath

public URIPath getClassPath()

Get an additional classpath where classes used by this extension can be found.