javax.ide.extension

Class DOMHook

java.lang.Object

javax.ide.extension.ElementVisitor

javax.ide.extension.ExtensionHook

javax.ide.extension.DOMHook

Direct Known Subclasses:

PreferenceDefaultsHook, ProjectDefaultsHook

public abstract class DOMHook
extends ExtensionHook

An extension hook that builds a DOM tree. The subclass must implement the getRootElementName() method and return an ElementName for the root element. This should match the ElementName this hook is registered for.

After extension hooks have been processed, call the getRootElement() method to get a DOM Element.

Since:

2.0

Nested Class Summary

Nested classes/interfaces inherited from class javax.ide.extension.ExtensionHook

ExtensionHook.URIResource

Nested classes/interfaces inherited from class javax.ide.extension.ElementVisitor

ElementVisitor.ResourceBundleProvider

Field Summary

Fields inherited from class javax.ide.extension.ExtensionHook

ATTRIBUTE_RSBUNDLE_CLASS, KEY_EXTENSION, KEY_RSBUNDLE_CLASS, MANIFEST_XMLNS

Fields inherited from class javax.ide.extension.ElementVisitor

KEY_LOCATOR

Constructor Summary

Constructors

Constructor and Description
DOMHook()

Method Summary

Modifier and Type	Method and Description
void	end(ElementEndContext context) Visit the end tag of an xml element.
org.w3c.dom.Element	getRootElement() Returns the root element of the DOM tree built using this hook.
protected abstract ElementName	getRootElementName() Gets the root element name to use.
void	start(ElementStartContext context) Visit the start tag of an xml element.

Methods inherited from class javax.ide.extension.ExtensionHook

findPath, getExtension, getProvider, getRSBundleClass, getSchemaLocation, resolvePath, setProvider, setSchemaLocation

Methods inherited from class javax.ide.extension.ElementVisitor

getAttributeHelper, getClassLoader, getMetaClassLoader, getResourceBundle, getResourceBundleProvider, getTextHelper, log, log, setResourceBundleProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

DOMHook

public DOMHook()

Method Detail

getRootElement

public org.w3c.dom.Element getRootElement()

Returns the root element of the DOM tree built using this hook.

Returns:

the root element of the DOM tree built using this hook.

start

public void start(ElementStartContext context)

Description copied from class: ElementVisitor

Visit the start tag of an xml element.

This implementation does nothing.

Overrides:

start in class ElementVisitor

Parameters:

context - information about the xml start tag.

end

public void end(ElementEndContext context)

Description copied from class: ElementVisitor

Visit the end tag of an xml element.

This implementation does nothing.

Overrides:

end in class ElementVisitor

Parameters:

context - information about the xml end tag.

getRootElementName

protected abstract ElementName getRootElementName()

Gets the root element name to use. This should match the ElementName this extension hook is registered for.

Returns:

the root element name to use.