| java.lang.Object
 org.eclipse.ui.internal.ide.registry.IDERegistryReader
All known Subclasses: org.eclipse.ui.internal.ide.registry.MarkerHelpRegistryReader, org.eclipse.ui.internal.ide.registry.ProjectImageRegistryReader,
| IDERegistryReader | | abstract public class IDERegistryReader (Code) | | Template implementation of a registry reader that creates objects
representing registry contents. Typically, an extension
contains one element, but this reader handles multiple
elements per extension.
To start reading the extensions from the registry for an
extension point, call the method readRegistry.
To read children of an IConfigurationElement, call the
method readElementChildren from your implementation
of the method readElement, as it will not be
done by default.
|
| Method Summary | |
| protected String | getDescription(IConfigurationElement config)
This method extracts description as a subelement of
the given element. | | protected void | logError(IConfigurationElement element, String text)
Logs the error in the workbench log using the provided
text and the information in the configuration element. | | protected void | logMissingAttribute(IConfigurationElement element, String attributeName)
Logs a very common registry error when a required attribute is missing. | | protected void | logMissingElement(IConfigurationElement element, String elementName)
Logs a very common registry error when a required child is missing. | | protected void | logUnknownElement(IConfigurationElement element)
Logs a registry error when the configuration element is unknown. | | protected IExtension[] | orderExtensions(IExtension[] extensions)
Apply a reproducable order to the list of extensions
provided, such that the order will not change as
extensions are added or removed. | | abstract protected boolean | readElement(IConfigurationElement element)
Implement this method to read element's attributes. | | protected void | readElementChildren(IConfigurationElement element)
Read the element's children. | | protected void | readElements(IConfigurationElement[] elements)
Read each element one at a time by calling the
subclass implementation of readElement. | | protected void | readExtension(IExtension extension)
Read one extension by looping through its
configuration elements. | | protected void | readRegistry(IExtensionRegistry registry, String pluginId, String extensionPoint)
Start the registry reading process using the
supplied plugin ID and extension point. |
| TAG_DESCRIPTION | | final protected static String TAG_DESCRIPTION(Code) | | |
| IDERegistryReader | | protected IDERegistryReader()(Code) | | The constructor.
|
| getDescription | | protected String getDescription(IConfigurationElement config)(Code) | | This method extracts description as a subelement of
the given element.
description string if defined, or empty stringif not. |
| logError | | protected void logError(IConfigurationElement element, String text)(Code) | | Logs the error in the workbench log using the provided
text and the information in the configuration element.
|
| logMissingAttribute | | protected void logMissingAttribute(IConfigurationElement element, String attributeName)(Code) | | Logs a very common registry error when a required attribute is missing.
|
| logMissingElement | | protected void logMissingElement(IConfigurationElement element, String elementName)(Code) | | Logs a very common registry error when a required child is missing.
|
| logUnknownElement | | protected void logUnknownElement(IConfigurationElement element)(Code) | | Logs a registry error when the configuration element is unknown.
|
| orderExtensions | | protected IExtension[] orderExtensions(IExtension[] extensions)(Code) | | Apply a reproducable order to the list of extensions
provided, such that the order will not change as
extensions are added or removed.
|
| readElement | | abstract protected boolean readElement(IConfigurationElement element)(Code) | | Implement this method to read element's attributes.
If children should also be read, then implementor
is responsible for calling readElementChildren.
Implementor is also responsible for logging missing
attributes.
true if element was recognized, false if not. |
| readElementChildren | | protected void readElementChildren(IConfigurationElement element)(Code) | | Read the element's children. This is called by
the subclass' readElement method when it wants
to read the children of the element.
|
| readElements | | protected void readElements(IConfigurationElement[] elements)(Code) | | Read each element one at a time by calling the
subclass implementation of readElement.
Logs an error if the element was not recognized.
|
| readExtension | | protected void readExtension(IExtension extension)(Code) | | Read one extension by looping through its
configuration elements.
|
| readRegistry | | protected void readRegistry(IExtensionRegistry registry, String pluginId, String extensionPoint)(Code) | | Start the registry reading process using the
supplied plugin ID and extension point.
|
|
|