org.eclipse.core.internal.registry

Class ConfigurationElementHandle

java.lang.Object

org.eclipse.core.internal.registry.Handle

org.eclipse.core.internal.registry.ConfigurationElementHandle

All Implemented Interfaces:

IConfigurationElement

Direct Known Subclasses:

ThirdLevelConfigurationElementHandle

public class ConfigurationElementHandle
extends Handle
implements IConfigurationElement

Since:

3.1

Field Summary

Fields inherited from class org.eclipse.core.internal.registry.Handle

objectManager

Constructor Summary

Constructors

Constructor and Description
ConfigurationElementHandle(IObjectManager objectManager, int id)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	createExecutableExtension(java.lang.String propertyName) Creates and returns a new instance of the executable extension identified by the named attribute of this configuration element.
java.lang.String	getAttribute(java.lang.String propertyName) Returns the named attribute of this configuration element, or null if none.
java.lang.String	getAttribute(java.lang.String attrName, java.lang.String locale) When multi-language support is enabled, this method returns the named attribute of this configuration element in the specified locale, or null if none.
java.lang.String	getAttributeAsIs(java.lang.String name) Returns the named attribute of this configuration element, or null if none.
java.lang.String[]	getAttributeNames() Returns the names of the attributes of this configuration element.
IConfigurationElement[]	getChildren() Returns all configuration elements that are children of this configuration element.
IConfigurationElement[]	getChildren(java.lang.String name) Returns all child configuration elements with the given name.
protected ConfigurationElement	getConfigurationElement()
IContributor	getContributor() Returns the contributor of this configuration element.
IExtension	getDeclaringExtension() Returns the extension that declares this configuration element.
int	getHandleId() Returns unique identifier of the registry object from which this element was created.
java.lang.String	getName() Returns the name of this configuration element.
java.lang.String	getNamespace() Returns the namespace for this configuration element.
java.lang.String	getNamespaceIdentifier() Returns the namespace name for this configuration element.
java.lang.Object	getParent() Returns the element which contains this element.
java.lang.String	getValue() Returns the text value of this configuration element.
java.lang.String	getValue(java.lang.String locale) When multi-language support is enabled, this method returns the text value of this configuration element in the specified locale, or null if none.
java.lang.String	getValueAsIs() Returns the untranslated text value of this configuration element.
boolean	isValid() Returns whether this configuration element object is valid.
protected boolean	shouldPersist()
java.lang.String	toString() WARNING: this method must return string containing getHandleId() identifier, because some clients might have misused previously returned Object.toString() value which was in fact just Handle.hashCode() value which in turn was alwas the value of getHandleId().

Methods inherited from class org.eclipse.core.internal.registry.Handle

equals, getId, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.core.runtime.IConfigurationElement

equals

Constructor Detail

ConfigurationElementHandle

public ConfigurationElementHandle(IObjectManager objectManager,
                                  int id)

Method Detail

getConfigurationElement

protected ConfigurationElement getConfigurationElement()

shouldPersist

protected boolean shouldPersist()

getAttribute

public java.lang.String getAttribute(java.lang.String propertyName)

Description copied from interface: IConfigurationElement

Returns the named attribute of this configuration element, or null if none.

The names of configuration element attributes are the same as the attribute names of the corresponding XML element. For example, the configuration markup

 <bg pattern="stripes"/>
 

corresponds to a configuration element named "bg" with an attribute named "pattern" with attribute value "stripes".

Note that any translation specified in the plug-in manifest file is automatically applied.

Specified by:

getAttribute in interface IConfigurationElement

Parameters:

propertyName - the name of the attribute

Returns:

attribute value, or null if none

getAttribute

public java.lang.String getAttribute(java.lang.String attrName,
                                     java.lang.String locale)

Description copied from interface: IConfigurationElement

When multi-language support is enabled, this method returns the named attribute of this configuration element in the specified locale, or null if none.

The locale matching tries to find the best match between available translations and the requested locale, falling back to a more generic locale ("en") when the specific locale ("en_US") is not available.

If multi-language support is not enabled, this method is equivalent to the method IConfigurationElement.getAttribute(String).

Specified by:

getAttribute in interface IConfigurationElement

Parameters:

attrName - the name of the attribute

locale - the requested locale

Returns:

attribute value, or null if none

See Also:

IConfigurationElement.getAttribute(String), IExtensionRegistry.isMultiLanguage()

getAttributeNames

public java.lang.String[] getAttributeNames()

Description copied from interface: IConfigurationElement

Returns the names of the attributes of this configuration element. Returns an empty array if this configuration element has no attributes.

The names of configuration element attributes are the same as the attribute names of the corresponding XML element. For example, the configuration markup

 <bg color="blue" pattern="stripes"/>
 

corresponds to a configuration element named "bg" with attributes named "color" and "pattern".

Specified by:

getAttributeNames in interface IConfigurationElement

Returns:

the names of the attributes

getChildren

public IConfigurationElement[] getChildren()

Description copied from interface: IConfigurationElement

Returns all configuration elements that are children of this configuration element. Returns an empty array if this configuration element has no children.

Each child corresponds to a nested XML element in the configuration markup. For example, the configuration markup

 <view>
     <verticalHint>top</verticalHint>
     <horizontalHint>left</horizontalHint>
 </view>
 

corresponds to a configuration element, named "view", with two children.

Specified by:

getChildren in interface IConfigurationElement

Returns:

the child configuration elements

See Also:

IConfigurationElement.getChildren(String)

createExecutableExtension

public java.lang.Object createExecutableExtension(java.lang.String propertyName)
                                           throws CoreException

Description copied from interface: IConfigurationElement

Creates and returns a new instance of the executable extension identified by the named attribute of this configuration element. The named attribute value must contain a fully qualified name of a Java class. The class can either refer to a class implementing the executable extension or to a factory capable of returning the executable extension.

The specified class is instantiated using its 0-argument public constructor.

Then the following checks are done:
If the specified class implements the IExecutableExtension interface, the method IExecutableExtension.setInitializationData(IConfigurationElement, String, Object) is called, passing to the object the configuration information that was used to create it.

If the specified class implements IExecutableExtensionFactory interface, the method IExecutableExtensionFactory.create() is invoked.

Unlike other methods on this object, invoking this method may activate the plug-in.

Specified by:

createExecutableExtension in interface IConfigurationElement

Parameters:

propertyName - the name of the property

Returns:

the executable instance

Throws:

CoreException - if an instance of the executable extension could not be created for any reason

See Also:

IExecutableExtension.setInitializationData(IConfigurationElement, String, Object), IExecutableExtensionFactory

getAttributeAsIs

public java.lang.String getAttributeAsIs(java.lang.String name)

Description copied from interface: IConfigurationElement

Returns the named attribute of this configuration element, or null if none.

The names of configuration element attributes are the same as the attribute names of the corresponding XML element. For example, the configuration markup

 <bg pattern="stripes"/>
 

corresponds to a configuration element named "bg" with an attribute named "pattern" with attribute value "stripes".

Note that any translation specified in the plug-in manifest file for this attribute is not automatically applied.

Specified by:

getAttributeAsIs in interface IConfigurationElement

Parameters:

name - the name of the attribute

Returns:

attribute value, or null if none

getChildren

public IConfigurationElement[] getChildren(java.lang.String name)

Description copied from interface: IConfigurationElement

Returns all child configuration elements with the given name. Returns an empty array if this configuration element has no children with the given name.

Specified by:

getChildren in interface IConfigurationElement

Parameters:

name - the name of the child configuration element

Returns:

the child configuration elements with that name

See Also:

IConfigurationElement.getChildren()

getDeclaringExtension

public IExtension getDeclaringExtension()

Description copied from interface: IConfigurationElement

Returns the extension that declares this configuration element.

Specified by:

getDeclaringExtension in interface IConfigurationElement

Returns:

the extension

getName

public java.lang.String getName()

Description copied from interface: IConfigurationElement

Returns the name of this configuration element. The name of a configuration element is the same as the XML tag of the corresponding XML element. For example, the configuration markup

 <wizard name="Create Project"/>
 

corresponds to a configuration element named "wizard".

Specified by:

getName in interface IConfigurationElement

Returns:

the name of this configuration element

getParent

public java.lang.Object getParent()

Description copied from interface: IConfigurationElement

Returns the element which contains this element. If this element is an immediate child of an extension, the returned value can be downcast to IExtension. Otherwise the returned value can be downcast to IConfigurationElement.

Specified by:

getParent in interface IConfigurationElement

Returns:

the parent of this configuration element or null

getValue

public java.lang.String getValue()

Description copied from interface: IConfigurationElement

Returns the text value of this configuration element. For example, the configuration markup

 <script lang="javascript">.\scripts\cp.js</script>
 

corresponds to a configuration element "script" with value ".\scripts\cp.js".

Values may span multiple lines (i.e., contain carriage returns and/or line feeds).

Note that any translation specified in the plug-in manifest file is automatically applied.

Specified by:

getValue in interface IConfigurationElement

Returns:

the text value of this configuration element or null

getValue

public java.lang.String getValue(java.lang.String locale)

Description copied from interface: IConfigurationElement

When multi-language support is enabled, this method returns the text value of this configuration element in the specified locale, or null if none.

The locale matching tries to find the best match between available translations and the requested locale, falling back to a more generic locale ("en") when the specific locale ("en_US") is not available.

If multi-language support is not enabled, this method is equivalent to the method IConfigurationElement.getValue().

Specified by:

getValue in interface IConfigurationElement

Parameters:

locale - the requested locale

Returns:

the text value of this configuration element in the specified locale, or null

See Also:

IConfigurationElement.getValue(String), IExtensionRegistry.isMultiLanguage()

getValueAsIs

public java.lang.String getValueAsIs()

Description copied from interface: IConfigurationElement

Returns the untranslated text value of this configuration element. For example, the configuration markup

 <script lang="javascript">.\scripts\cp.js</script>
 

corresponds to a configuration element "script" with value ".\scripts\cp.js".

Values may span multiple lines (i.e., contain carriage returns and/or line feeds).

Note that translation specified in the plug-in manifest file is not automatically applied. For example, the configuration markup

 <tooltip>#hattip</tooltip>
 

corresponds to a configuration element, named "tooltip", with value "#hattip".

Specified by:

getValueAsIs in interface IConfigurationElement

Returns:

the untranslated text value of this configuration element or null

getNamespace

public java.lang.String getNamespace()

Description copied from interface: IConfigurationElement

Returns the namespace for this configuration element. This value can be used in various global facilities to discover this configuration element's contributor.

Specified by:

getNamespace in interface IConfigurationElement

Returns:

the namespace for this configuration element

See Also:

IExtensionRegistry

getNamespaceIdentifier

public java.lang.String getNamespaceIdentifier()

Description copied from interface: IConfigurationElement

Returns the namespace name for this configuration element.

Specified by:

getNamespaceIdentifier in interface IConfigurationElement

Returns:

the namespace name for this configuration element

getContributor

public IContributor getContributor()

Description copied from interface: IConfigurationElement

Returns the contributor of this configuration element.

Specified by:

getContributor in interface IConfigurationElement

Returns:

the contributor for this configuration element

isValid

public boolean isValid()

Description copied from interface: IConfigurationElement

Returns whether this configuration element object is valid.

Specified by:

isValid in interface IConfigurationElement

Returns:

true if the object is valid, and false if it is no longer valid

getHandleId

public int getHandleId()

Description copied from interface: IConfigurationElement

Returns unique identifier of the registry object from which this element was created. Two configuration element instances are considered to be equal if their handle id's are same.

Specified by:

getHandleId in interface IConfigurationElement

Returns:

The handle id of the registry object from which this configuration element was created.

See Also:

IConfigurationElement.equals(Object)

toString

public java.lang.String toString()

WARNING: this method must return string containing getHandleId() identifier, because some clients might have misused previously returned Object.toString() value which was in fact just Handle.hashCode() value which in turn was alwas the value of getHandleId().

Please read bug 515587 for details.

Overrides:

toString in class java.lang.Object