Eclipse Platform
2.0

org.eclipse.core.runtime.model
Class ExtensionModel

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

public class ExtensionModel
extends PluginModelObject

An object which represents the user-defined extension in a plug-in manifest.

This class may be instantiated, or further subclassed.


Constructor Summary
ExtensionModel()
          Creates a new extension model in which all fields are null.
 
Method Summary
 String getExtensionPoint()
          Returns the extension point with which this extension is associated.
 String getId()
          Returns the simple identifier of this extension, or null if this extension does not have an identifier.
 PluginModel getParent()
          Returns the plug-in model (descriptor or fragment) in which this extension is declared.
 PluginDescriptorModel getParentPluginDescriptor()
          Returns the plug-in descriptor in which this extension is declared.
 ConfigurationElementModel[] getSubElements()
          Returns the configuration element children of this extension.
 void markReadOnly()
          Sets this model object and all of its descendents to be read-only.
 void setExtensionPoint(String value)
          Set the extension point with which this extension is associated.
 void setId(String value)
          Sets the simple identifier of this extension, or null if this extension does not have an identifier.
 void setParent(PluginModel value)
          Sets the plug-in model in which this extension is declared.
 void setParentPluginDescriptor(PluginDescriptorModel value)
          Sets the plug-in descriptor in which this extension is declared.
 void setSubElements(ConfigurationElementModel[] value)
          Sets the configuration element children of this extension.
 
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

ExtensionModel

public ExtensionModel()
Creates a new extension model in which all fields are null.

Method Detail

getExtensionPoint

public String getExtensionPoint()
Returns the extension point with which this extension is associated.

Returns:
the extension point with which this extension is associated or null

getId

public String getId()
Returns the simple identifier of this extension, or null if this extension does not have an identifier. This identifier is specified in the plug-in manifest as a non-empty string containing no period characters ('.') and must be unique within the defining plug-in.

Returns:
the simple identifier of the extension (e.g. "main") or null

getParent

public PluginModel getParent()
Returns the plug-in model (descriptor or fragment) in which this extension is declared.

Returns:
the plug-in model in which this extension is declared or null

getParentPluginDescriptor

public PluginDescriptorModel getParentPluginDescriptor()
Returns the plug-in descriptor in which this extension is declared.

Returns:
the plug-in descriptor in which this extension is declared or null

getSubElements

public ConfigurationElementModel[] getSubElements()
Returns the configuration element children of this extension.

Returns:
the configuration elements in this extension 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()

setExtensionPoint

public void setExtensionPoint(String value)
Set the extension point with which this extension is associated. This object must not be read-only.

Returns:
the extension point with which this extension is associated. May be null.

setId

public void setId(String value)
Sets the simple identifier of this extension, or null if this extension does not have an identifier. This identifier is specified in the plug-in manifest as a non-empty string containing no period characters ('.') and must be unique within the defining plug-in. This object must not be read-only.

Parameters:
value - the simple identifier of the extension (e.g. "main"). May be null.

setParent

public void setParent(PluginModel value)
Sets the plug-in model in which this extension is declared. This object must not be read-only.

Parameters:
value - the plug-in model in which this extension is declared. May be null.

setParentPluginDescriptor

public void setParentPluginDescriptor(PluginDescriptorModel value)
Sets the plug-in descriptor in which this extension is declared. This object must not be read-only.

Parameters:
value - the plug-in descriptor in which this extension is declared. May be null.

setSubElements

public void setSubElements(ConfigurationElementModel[] value)
Sets the configuration element children of this extension. This object must not be read-only.

Parameters:
value - the configuration elements in this extension. May be null.

Eclipse Platform
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.