Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> ui >> internal >> [ registry overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.eclipse.ui.internal.registry
Class RegistryReader  

java.lang.Object
  org.eclipse.ui.internal.registry.RegistryReader

Direct Known Subclasses:

ActionSetPartAssociationsReader, ActionSetRegistryReader, EditorRegistryReader, PerspectiveExtensionReader, PerspectiveRegistryReader, PreferencePageRegistryReader, PropertyPagesRegistryReader, ViewRegistryReader, WizardsRegistryReader, WorkingSetRegistryReader

---

public abstract class RegistryReader

extends java.lang.Object

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.

---

Field Summary
protected static java.lang.String	TAG_DESCRIPTION

 

Constructor Summary
protected	RegistryReader()           The constructor.

 

Method Summary
protected  java.lang.String	getDescription(org.eclipse.core.runtime.IConfigurationElement config)           This method extracts description as a subelement of the given element.
protected static void	logError(org.eclipse.core.runtime.IConfigurationElement element, java.lang.String text)           Logs the error in the workbench log using the provided text and the information in the configuration element.
protected static void	logMissingAttribute(org.eclipse.core.runtime.IConfigurationElement element, java.lang.String attributeName)           Logs a very common registry error when a required attribute is missing.
protected static void	logMissingElement(org.eclipse.core.runtime.IConfigurationElement element, java.lang.String elementName)           Logs a very common registry error when a required child is missing.
protected static void	logUnknownElement(org.eclipse.core.runtime.IConfigurationElement element)           Logs a registry error when the configuration element is unknown.
protected  org.eclipse.core.runtime.IExtension[]	orderExtensions(org.eclipse.core.runtime.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.
protected abstract  boolean	readElement(org.eclipse.core.runtime.IConfigurationElement element)           Implement this method to read element's attributes.
protected  void	readElementChildren(org.eclipse.core.runtime.IConfigurationElement element)           Read the element's children.
protected  void	readElements(org.eclipse.core.runtime.IConfigurationElement[] elements)           Read each element one at a time by calling the subclass implementation of readElement.
protected  void	readExtension(org.eclipse.core.runtime.IExtension extension)           Read one extension by looping through its configuration elements.
void	readRegistry(org.eclipse.core.runtime.IExtensionRegistry registry, java.lang.String pluginId, java.lang.String extensionPoint)           Start the registry reading process using the supplied plugin ID and extension point.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

TAG_DESCRIPTION

protected static final java.lang.String TAG_DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

RegistryReader

protected RegistryReader()

The constructor.

Method Detail

getDescription

protected java.lang.String getDescription(org.eclipse.core.runtime.IConfigurationElement config)

This method extracts description as a subelement of the given element.

---

logError

protected static void logError(org.eclipse.core.runtime.IConfigurationElement element,
                               java.lang.String text)

Logs the error in the workbench log using the provided text and the information in the configuration element.

---

logMissingAttribute

protected static void logMissingAttribute(org.eclipse.core.runtime.IConfigurationElement element,
                                          java.lang.String attributeName)

Logs a very common registry error when a required attribute is missing.

---

logMissingElement

protected static void logMissingElement(org.eclipse.core.runtime.IConfigurationElement element,
                                        java.lang.String elementName)

Logs a very common registry error when a required child is missing.

---

logUnknownElement

protected static void logUnknownElement(org.eclipse.core.runtime.IConfigurationElement element)

Logs a registry error when the configuration element is unknown.

---

orderExtensions

protected org.eclipse.core.runtime.IExtension[] orderExtensions(org.eclipse.core.runtime.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.

---

readElement

protected abstract boolean readElement(org.eclipse.core.runtime.IConfigurationElement element)

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.

---

readElementChildren

protected void readElementChildren(org.eclipse.core.runtime.IConfigurationElement element)

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(org.eclipse.core.runtime.IConfigurationElement[] elements)

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(org.eclipse.core.runtime.IExtension extension)

Read one extension by looping through its configuration elements.

---

readRegistry

public void readRegistry(org.eclipse.core.runtime.IExtensionRegistry registry,
                         java.lang.String pluginId,
                         java.lang.String extensionPoint)

Start the registry reading process using the supplied plugin ID and extension point.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> ui >> internal >> [ registry overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---