org.eclipse.core.runtime.model
Class PluginModel

java.lang.Object
  |
  +--org.eclipse.core.runtime.model.PluginModelObject
        |
        +--org.eclipse.core.runtime.model.PluginModel

Direct Known Subclasses:

PluginDescriptorModel, PluginFragmentModel

public abstract class PluginModel

extends PluginModelObject

An object which represents the user-defined contents of a plug-in model (either a descriptor or a fragment) in a plug-in manifest.

This class may not be instantiated, but may be further subclassed.

Constructor Summary

PluginModel()
Creates a new plug-in descriptor model in which all fields are null.

Method Summary

ExtensionPointModel[]	getDeclaredExtensionPoints() Returns the extension points in this plug-in descriptor.
ExtensionModel[]	getDeclaredExtensions() Returns the extensions in this plug-in descriptor.
String	getId() Returns the unique identifier of this plug-in model or null.
String	getLocation() Returns the location of the plug-in manifest file (e.g., plugin.xml) which corresponds to this plug-in descriptor.
abstract String	getPluginId() Returns the unique identifier of the plug-in related to this model or null.
String	getProviderName() Returns the name of the provider who authored this plug-in.
PluginRegistryModel	getRegistry() Returns the plug-in registry of which this plug-in descriptor is a member.
PluginPrerequisiteModel[]	getRequires() Returns the prerequisites of this plug-in.
LibraryModel[]	getRuntime() Returns the libraries configured for this plug-in.
String	getVersion() Returns the version name of this plug-in.
void	markReadOnly() Sets this model object and all of its descendents to be read-only.
void	setDeclaredExtensionPoints(ExtensionPointModel[] value) Sets the extension points in this plug-in descriptor.
void	setDeclaredExtensions(ExtensionModel[] value) Sets the extensions in this plug-in descriptor.
void	setId(String value) Sets the unique identifier of this plug-in model.
void	setLocation(String value) Sets the location of the plug-in manifest file (e.g., plugin.xml) which corresponds to this plug-in descriptor.
void	setProviderName(String value) Sets the name of the provider who authored this plug-in.
void	setRegistry(PluginRegistryModel value) Sets the registry with which this plug-in descriptor is associated.
void	setRequires(PluginPrerequisiteModel[] value) Sets the prerequisites of this plug-in.
void	setRuntime(LibraryModel[] value) Sets the libraries configured for this plug-in.
void	setVersion(String value) Sets the version name of this plug-in.

Methods inherited from class org.eclipse.core.runtime.model.PluginModelObject

assertIsWriteable, getName, isReadOnly, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginModel

public PluginModel()

Creates a new plug-in descriptor model in which all fields are null.

Method Detail

getDeclaredExtensionPoints

public ExtensionPointModel[] getDeclaredExtensionPoints()

Returns the extension points in this plug-in descriptor.

Returns:

the extension points in this plug-in descriptor or null

getDeclaredExtensions

public ExtensionModel[] getDeclaredExtensions()

Returns the extensions in this plug-in descriptor.

Returns:

the extensions in this plug-in descriptor or null

getId

public String getId()

Returns the unique identifier of this plug-in model or null. This identifier is a non-empty string and is unique within the plug-in registry.

Returns:

the unique identifier of this plugin model (e.g. "com.example") or null.

getLocation

public String getLocation()

Returns the location of the plug-in manifest file (e.g., plugin.xml) which corresponds to this plug-in descriptor. The location is in the form of a URL.

Returns:

the location of this plug-in descriptor or null.

getPluginId

public abstract String getPluginId()

Returns the unique identifier of the plug-in related to this model or null. This identifier is a non-empty string and is unique within the plug-in registry.

Returns:

the unique identifier of the plug-in related to this model (e.g. "com.example") or null.

getProviderName

public String getProviderName()

Returns the name of the provider who authored this plug-in.

Returns:

name of the provider who authored this plug-in or null

getRegistry

public PluginRegistryModel getRegistry()

Returns the plug-in registry of which this plug-in descriptor is a member.

Returns:

the registry in which this descriptor has been installed or null if none.

getRequires

public PluginPrerequisiteModel[] getRequires()

Returns the prerequisites of this plug-in.

Returns:

the prerequisites of this plug-in or null

getRuntime

public LibraryModel[] getRuntime()

Returns the libraries configured for this plug-in.

Returns:

the libraries configured for this plug-in or null

getVersion

public String getVersion()

Returns the version name of this plug-in.

Returns:

the version name of this plug-in or null

markReadOnly

public void markReadOnly()

Sets this model object and all of its descendents to be read-only. Subclasses may extend this implementation.

Overrides:

markReadOnly in class PluginModelObject

See Also:

PluginModelObject.isReadOnly()

setDeclaredExtensionPoints

public void setDeclaredExtensionPoints(ExtensionPointModel[] value)

Sets the extension points in this plug-in descriptor. This object must not be read-only.

Parameters:

value - the extension points in this plug-in descriptor. May be null.

setDeclaredExtensions

public void setDeclaredExtensions(ExtensionModel[] value)

Sets the extensions in this plug-in descriptor. This object must not be read-only.

Parameters:

value - the extensions in this plug-in descriptor. May be null.

setId

public void setId(String value)

Sets the unique identifier of this plug-in model. The identifier is a non-empty string and is unique within the plug-in registry. This object must not be read-only.

Parameters:

value - the unique identifier of the plug-in model (e.g. "com.example"). May be null.

setLocation

public void setLocation(String value)

Sets the location of the plug-in manifest file (e.g., plugin.xml) which corresponds to this plug-in descriptor. The location is in the form of a URL. This object must not be read-only.

Parameters:

value - the location of this plug-in descriptor. May be null.

setProviderName

public void setProviderName(String value)

Sets the name of the provider who authored this plug-in. This object must not be read-only.

Parameters:

value - name of the provider who authored this plug-in. May be null.

setRegistry

public void setRegistry(PluginRegistryModel value)

Sets the registry with which this plug-in descriptor is associated. This object must not be read-only.

Parameters:

value - the registry with which this plug-in is associated. May be null.

setRequires

public void setRequires(PluginPrerequisiteModel[] value)

Sets the prerequisites of this plug-in. This object must not be read-only.

Parameters:

value - the prerequisites of this plug-in. May be null.

setRuntime

public void setRuntime(LibraryModel[] value)

Sets the libraries configured for this plug-in. This object must not be read-only.

Parameters:

value - the libraries configured for this plug-in. May be null.

setVersion

public void setVersion(String value)

Sets the version name of this plug-in. The version number is canonicalized. This object must not be read-only.

Parameters:

value - the version name of this plug-in. May be null.