org.eclipse.core.internal.registry.spi

Class ConfigurationElementDescription

java.lang.Object

org.eclipse.core.internal.registry.spi.ConfigurationElementDescription

public final class ConfigurationElementDescription
extends java.lang.Object

Describes configuration elements (content of an extension) to be added to the extension registry. Configuration element can contain attributes or a String value. Configuration element can contain other configuration elements (children).

It is expected that configuration element's name is not null. Attributes and children of the extension description might be null; value might be null as well.

This class can be instantiated.

This class is not intended to be subclassed.

See Also:

ConfigurationElementAttribute

Constructor Summary

Constructors

Constructor and Description
ConfigurationElementDescription(java.lang.String name, ConfigurationElementAttribute[] attributes, java.lang.String value, ConfigurationElementDescription[] children) Constructor.
ConfigurationElementDescription(java.lang.String name, ConfigurationElementAttribute attribute, java.lang.String value, ConfigurationElementDescription[] children) Constructor.

Method Summary

Modifier and Type	Method and Description
ConfigurationElementAttribute[]	getAttributes() Returns attributes of the configuration element.
ConfigurationElementDescription[]	getChildren() Returns children of the configuration element.
java.lang.String	getName() Returns name of the configuration element.
java.lang.String	getValue() Returns string value stored in the configuration element.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationElementDescription

public ConfigurationElementDescription(java.lang.String name,
                                       ConfigurationElementAttribute[] attributes,
                                       java.lang.String value,
                                       ConfigurationElementDescription[] children)

Constructor.

Parameters:

name - - name of the configuration element

attributes - - attributes of the configuration element. Might be null.

value - - string value to be stored. Might be null.

children - - children of the configuration element. Might be null.

See Also:

IConfigurationElement.getName(), IConfigurationElement.getChildren(), IConfigurationElement.getAttribute(String), IConfigurationElement.getValue()

ConfigurationElementDescription

public ConfigurationElementDescription(java.lang.String name,
                                       ConfigurationElementAttribute attribute,
                                       java.lang.String value,
                                       ConfigurationElementDescription[] children)

Constructor.

Parameters:

name - - name of the configuration element

attribute - - attribute of the configuration element. Might be null.

value - - string value to be stored. Might be null.

children - - children of the configuration element. Might be null.

See Also:

IConfigurationElement.getName(), IConfigurationElement.getChildren(), IConfigurationElement.getAttribute(String), IConfigurationElement.getValue()

Method Detail

getChildren

public ConfigurationElementDescription[] getChildren()

Returns children of the configuration element.

Returns:

- children of the extension

See Also:

IConfigurationElement.getChildren()

getName

public java.lang.String getName()

Returns name of the configuration element.

Returns:

- extension name

See Also:

IConfigurationElement.getName()

getAttributes

public ConfigurationElementAttribute[] getAttributes()

Returns attributes of the configuration element.

Returns:

- attributes of the extension description

See Also:

IConfigurationElement.getAttribute(String)

getValue

public java.lang.String getValue()

Returns string value stored in the configuration element.

Returns:

- String value to be stored in the element

See Also:

IConfigurationElement.getValue()