public class NamespaceSupport2 extends org.xml.sax.helpers.NamespaceSupport
This class is an attempt to rewrite the SAX NamespaceSupport "helper" class for improved efficiency. It can be used to track the namespace declarations currently in scope, providing lookup routines to map prefixes to URIs and vice versa.
ISSUE: For testing purposes, I've extended NamespaceSupport even though I'm completely reasserting all behaviors and fields. Wasteful.... But SAX did not put an interface under that object and we seem to have written that SAX class into our APIs... and I don't want to argue with it right now.
NamespaceSupport
Modifier and Type | Field and Description |
---|---|
static String |
XMLNS
The XML Namespace as a constant.
|
NSDECL
Constructor and Description |
---|
NamespaceSupport2()
Create a new Namespace support object.
|
Modifier and Type | Method and Description |
---|---|
boolean |
declarePrefix(String prefix,
String uri)
Declare a Namespace prefix.
|
Enumeration |
getDeclaredPrefixes()
Return an enumeration of all prefixes declared in this context.
|
String |
getPrefix(String uri)
Return one of the prefixes mapped to a Namespace URI.
|
Enumeration |
getPrefixes()
Return an enumeration of all prefixes currently declared.
|
Enumeration |
getPrefixes(String uri)
Return an enumeration of all prefixes currently declared for a URI.
|
String |
getURI(String prefix)
Look up a prefix and get the currently-mapped Namespace URI.
|
void |
popContext()
Revert to the previous Namespace context.
|
String[] |
processName(String qName,
String[] parts,
boolean isAttribute)
Process a raw XML 1.0 name.
|
void |
pushContext()
Start a new Namespace context.
|
void |
reset()
Reset this Namespace support object for reuse.
|
isNamespaceDeclUris, setNamespaceDeclUris
public static final String XMLNS
This is the Namespace URI that is automatically mapped to the "xml" prefix.
public NamespaceSupport2()
public void reset()
It is necessary to invoke this method before reusing the Namespace support object for a new session.
reset
in class org.xml.sax.helpers.NamespaceSupport
public void pushContext()
Normally, you should push a new context at the beginning of each XML element: the new context will automatically inherit the declarations of its parent context, but it will also keep track of which declarations were made within this context.
The Namespace support object always starts with a base context already in force: in this context, only the "xml" prefix is declared.
pushContext
in class org.xml.sax.helpers.NamespaceSupport
popContext()
public void popContext()
Normally, you should pop the context at the end of each XML element. After popping the context, all Namespace prefix mappings that were previously in force are restored.
You must not attempt to declare additional Namespace prefixes after popping a context, unless you push another context first.
popContext
in class org.xml.sax.helpers.NamespaceSupport
pushContext()
public boolean declarePrefix(String prefix, String uri)
This method declares a prefix in the current Namespace context; the prefix will remain in force until this context is popped, unless it is shadowed in a descendant context.
To declare a default Namespace, use the empty string. The prefix must not be "xml" or "xmlns".
Note that you must not declare a prefix after you've pushed and popped another Namespace.
Note that there is an asymmetry in this library: while getPrefix
will not return the default "" prefix,
even if you have declared one; to check for a default prefix,
you have to look it up explicitly using getURI
.
This asymmetry exists to make it easier to look up prefixes
for attribute names, where the default prefix is not allowed.
declarePrefix
in class org.xml.sax.helpers.NamespaceSupport
prefix
- The prefix to declare, or null for the empty
string.uri
- The Namespace URI to associate with the prefix.processName(java.lang.String, java.lang.String[], boolean)
,
getURI(java.lang.String)
,
getPrefix(java.lang.String)
public String[] processName(String qName, String[] parts, boolean isAttribute)
This method processes a raw XML 1.0 name in the current context by removing the prefix and looking it up among the prefixes currently declared. The return value will be the array supplied by the caller, filled in as follows:
All of the strings in the array will be internalized. If the raw name has a prefix that has not been declared, then the return value will be null.
Note that attribute names are processed differently than element names: an unprefixed element name will received the default Namespace (if any), while an unprefixed element name will not.
processName
in class org.xml.sax.helpers.NamespaceSupport
qName
- The raw XML 1.0 name to be processed.parts
- A string array supplied by the caller, capable of
holding at least three members.isAttribute
- A flag indicating whether this is an
attribute name (true) or an element name (false).declarePrefix(java.lang.String, java.lang.String)
,
String.intern()
public String getURI(String prefix)
This method looks up the prefix in the current context. Use the empty string ("") for the default Namespace.
getURI
in class org.xml.sax.helpers.NamespaceSupport
prefix
- The prefix to look up.getPrefix(java.lang.String)
,
getPrefixes()
public Enumeration getPrefixes()
Note: if there is a default prefix, it will not be
returned in this enumeration; check for the default prefix
using the getURI
with an argument of "".
getPrefixes
in class org.xml.sax.helpers.NamespaceSupport
getDeclaredPrefixes()
,
getURI(java.lang.String)
public String getPrefix(String uri)
If more than one prefix is currently mapped to the same
URI, this method will make an arbitrary selection; if you
want all of the prefixes, use the getPrefixes()
method instead.
Note: this will never return the empty
(default) prefix; to check for a default prefix, use the getURI
method with an argument of "".
getPrefix
in class org.xml.sax.helpers.NamespaceSupport
uri
- The Namespace URI.getPrefixes(java.lang.String)
,
getURI(java.lang.String)
public Enumeration getPrefixes(String uri)
This method returns prefixes mapped to a specific Namespace
URI. The xml: prefix will be included. If you want only one
prefix that's mapped to the Namespace URI, and you don't care
which one you get, use the getPrefix
method instead.
Note: the empty (default) prefix is
never included in this enumeration; to check for the
presence of a default Namespace, use the getURI
method with an argument of "".
getPrefixes
in class org.xml.sax.helpers.NamespaceSupport
uri
- The Namespace URI.getPrefix(java.lang.String)
,
getDeclaredPrefixes()
,
getURI(java.lang.String)
public Enumeration getDeclaredPrefixes()
The empty (default) prefix will be included in this
enumeration; note that this behaviour differs from that of
getPrefix(java.lang.String)
and getPrefixes()
.
getDeclaredPrefixes
in class org.xml.sax.helpers.NamespaceSupport
getPrefixes()
,
getURI(java.lang.String)
Copyright © 2016 JBoss by Red Hat. All rights reserved.