| java.lang.Object
 org.eclipse.ui.internal.registry.RegistryReader
All known Subclasses: org.eclipse.ui.internal.preferences.SettingsTransferRegistryReader, org.eclipse.ui.internal.registry.CategorizedPageRegistryReader, org.eclipse.ui.internal.registry.WizardsRegistryReader, org.eclipse.ui.internal.registry.PerspectiveRegistryReader, org.eclipse.ui.internal.registry.PreferenceTransferRegistryReader, org.eclipse.ui.internal.themes.ThemeRegistryReader, org.eclipse.ui.internal.ObjectActionContributorReader, org.eclipse.ui.internal.registry.ViewRegistryReader, org.eclipse.ui.internal.registry.PerspectiveExtensionReader, org.eclipse.ui.internal.registry.WorkingSetRegistryReader, org.eclipse.ui.internal.PluginActionBuilder, org.eclipse.ui.internal.PluginActionSetReader, org.eclipse.ui.internal.registry.EditorRegistryReader, org.eclipse.ui.internal.decorators.DecoratorRegistryReader,
| RegistryReader | | abstract public class RegistryReader (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 | |
| public static String | getClassValue(IConfigurationElement configElement, String classAttributeName)
Utility for extracting the value of a class attribute or a nested class
element that follows the pattern set forth by
org.eclipse.core.runtime.IExecutableExtension . | | public static String | getDescription(IConfigurationElement configElement)
Utility for extracting the description child of an element. | | protected static 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 static void | logMissingAttribute(IConfigurationElement element, String attributeName)
Logs a very common registry error when a required attribute is missing. | | protected static void | logMissingElement(IConfigurationElement element, String elementName)
Logs a very common registry error when a required child is missing. | | protected static void | logUnknownElement(IConfigurationElement element)
Logs a registry error when the configuration element is unknown. | | public static 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. | | public void | readRegistry(IExtensionRegistry registry, String pluginId, String extensionPoint)
Start the registry reading process using the
supplied plugin ID and extension point. |
| RegistryReader | | protected RegistryReader()(Code) | | The constructor.
|
| getClassValue | | public static String getClassValue(IConfigurationElement configElement, String classAttributeName)(Code) | | Utility for extracting the value of a class attribute or a nested class
element that follows the pattern set forth by
org.eclipse.core.runtime.IExecutableExtension .
Parameters:
configElement - the element
Parameters:
classAttributeName - the name of the class attribute to check the value of the attribute or nested class element
since:
3.1 |
| getDescription | | public static String getDescription(IConfigurationElement configElement)(Code) | | Utility for extracting the description child of an element.
Parameters:
configElement - the element the description
since:
3.1 |
| logError | | protected static 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 static void logMissingAttribute(IConfigurationElement element, String attributeName)(Code) | | Logs a very common registry error when a required attribute is missing.
|
| logMissingElement | | protected static void logMissingElement(IConfigurationElement element, String elementName)(Code) | | Logs a very common registry error when a required child is missing.
|
| logUnknownElement | | protected static void logUnknownElement(IConfigurationElement element)(Code) | | Logs a registry error when the configuration element is unknown.
|
| orderExtensions | | public static 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.
Parameters:
extensions - the extensions to order ordered extensions |
| 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 | | public void readRegistry(IExtensionRegistry registry, String pluginId, String extensionPoint)(Code) | | Start the registry reading process using the
supplied plugin ID and extension point.
Parameters:
registry - the registry to read from
Parameters:
pluginId - the plugin id of the extenion point
Parameters:
extensionPoint - the extension point id |
|
|