|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.4.0) E13403-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.ide.extension.ElementVisitor javax.ide.extension.ExtensionHook oracle.ide.extension.HashStructureHook
public class HashStructureHook
Generic extension hook for unmarshalling extension manifest elements
into a HashStructure
. As a general rule, all elements are
unmarshalled as HashStructure, and attributes are values in that
HashStructure.
See HashStructureElementVisitor
for details on how the
extension manifest elements and attributes are unmarshalled into
a HashStructure.
Field Summary |
---|
Fields inherited from class javax.ide.extension.ExtensionHook |
---|
KEY_EXTENSION, KEY_RSBUNDLE_CLASS, MANIFEST_XMLNS |
Fields inherited from class javax.ide.extension.ElementVisitor |
---|
KEY_LOCATOR |
Constructor Summary | |
---|---|
|
HashStructureHook()
Constructor invoked by the extension registry. |
protected |
HashStructureHook(boolean countElementOrder)
When a custom hook requires that the order of elements be kept by the hash structure, they should call this constructor to turn element counting on. |
Method Summary | |
---|---|
void |
dispose()
Frees all information stored by this hook. |
void |
end(ElementEndContext context)
Visit the end tag of an xml element. |
static java.lang.String |
getExtensionId(HashStructure context)
Tries to find id of the extension that was responsible for populating the specified hash structure. |
HashStructure |
getHashStructure()
Gets the hash structure constructed for this hook. |
java.util.Collection<NameValuePair<HashStructure>> |
getOrderedElements(HashStructure hash)
Given a HashStructure representing a custom hook element that
contains non-homogenous elements, get an ordered collection of hash structures
encapsulating those elements. |
static java.lang.String |
getText(HashStructure context)
Gets the text content of some hash structure. |
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 |
---|
getClassLoader, getResourceBundle, log |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected HashStructureHook(boolean countElementOrder)
Extension writers with custom hooks where element order matters must subclass this class and invoke this constructor from their constructor to turn on element counting.
countElementOrder
- flag indicating whether to elements should be
counted to record the order they appear in the extension manifest.public HashStructureHook()
Method Detail |
---|
public final HashStructure getHashStructure()
java.lang.IllegalStateException
- if the dispose()
method has been
called.public void start(ElementStartContext context)
ElementVisitor
This implementation does nothing.
start
in class ElementVisitor
context
- information about the xml start tag.public final void end(ElementEndContext context)
ElementVisitor
This implementation does nothing.
end
in class ElementVisitor
context
- information about the xml end tag.public static final java.lang.String getExtensionId(HashStructure context)
context
- a HashStructure. Usually this will not be the
HashStructure returned by the getHashStructure()
method, because
that is the root structure, and no single extension is responsible
for it. Must not be null.
public static final java.lang.String getText(HashStructure context)
context.getString( "#text" ).
context
- a HashStructure. Must not be null.
public void dispose()
getHashStructure()
method after dispose is not permitted, and
will throw an IllegalStateException.
public java.util.Collection<NameValuePair<HashStructure>> getOrderedElements(HashStructure hash)
HashStructure
representing a custom hook element that
contains non-homogenous elements, get an ordered collection of hash structures
encapsulating those elements.
hash
- the hash structure whose ordered elements are requested.
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.4.0) E13403-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |