Package com.bc.ceres.core.runtime

Interface ConfigurationElement

All Superinterfaces:

ConfigurationElementBase<ConfigurationElement>

public interface ConfigurationElement
extends ConfigurationElementBase<ConfigurationElement>

A configuration element of an extension.

This interface also provides a way to create executable extension objects.

This interface is not intended to be implemented by clients.

Method Summary

Modifier and Type	Method	Description
<T> T	createExecutableExtension(Class<T> extensionType)	Creates and returns a new instance of the executable extension identified by the named attribute of this configuration element.
Extension	getDeclaringExtension()	Gets the declaring extension, if this is an element of an extension configuration.
ConfigurationSchemaElement	getSchemaElement()	Gets the corresponding schema element, if this is an element of an extension configuration.

Methods inherited from interface com.bc.ceres.core.runtime.ConfigurationElementBase

getAttribute, getAttributeNames, getChild, getChildren, getChildren, getName, getParent, getValue

Method Details

getSchemaElement

ConfigurationSchemaElement getSchemaElement()

Gets the corresponding schema element, if this is an element of an extension configuration.

Returns:

The schema element, or null if this is a schema element.

See Also:

• getDeclaringExtension()

getDeclaringExtension

Extension getDeclaringExtension()

Gets the declaring extension, if this is an element of an extension configuration.

Returns:

The declaring extension, or null if this is a schema element.

See Also:

• getSchemaElement()

createExecutableExtension

<T> T createExecutableExtension(Class<T> extensionType)
                         throws CoreException

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 implementing the executable extension.

The specified class is instantiated using its 0-argument public constructor. If the specified class implements the ConfigurableExtension interface, its ConfigurableExtension.configure(ConfigurationElement) configure} method is called, passing to the object the configuration information that was used to create it.

Parameters:

extensionType - the expected type of the executable extension instance

Returns:

the executable instance

Throws:

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

RuntimeException - if this is a schema element