public interface NamespaceContext
The prefix and namespace must be identical references for equal strings, thus
each string should be internalized (@see String.intern())
or added to the SymbolTable
Modifier and Type | Field and Description |
---|---|
static String |
XML_URI
The XML Namespace ("http://www.w3.org/XML/1998/namespace").
|
static String |
XMLNS_URI
XML Information Set REC
all namespace attributes (including those named xmlns,
whose [prefix] property has no value) have a namespace URI of http://www.w3.org/2000/xmlns/
|
Modifier and Type | Method and Description |
---|---|
boolean |
declarePrefix(String prefix,
String uri)
Declare a Namespace prefix.
|
Enumeration |
getAllPrefixes()
Return an enumeration of all prefixes whose declarations are active
in the current context.
|
String |
getDeclaredPrefixAt(int index)
Returns the prefix at the specified index in the current context.
|
int |
getDeclaredPrefixCount()
Return a count of locally declared prefixes, including
the default prefix if bound.
|
String |
getPrefix(String uri)
Look up a namespace URI and get one of the mapped prefix.
|
String |
getURI(String prefix)
Look up a prefix and get the currently-mapped Namespace URI.
|
void |
popContext()
Revert to the previous Namespace context.
|
void |
pushContext()
Start a new Namespace context.
|
void |
reset()
Reset this Namespace support object for reuse.
|
static final String XML_URI
static final String XMLNS_URI
void pushContext()
A new context should be pushed 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.
popContext()
void popContext()
The context should be popped at the end of each XML element. After popping the context, all Namespace prefix mappings that were previously in force are restored.
Users must not attempt to declare additional Namespace prefixes after popping a context, unless you push another context first.
pushContext()
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.
Note that to declare a default Namespace, use the empty string. The prefixes "xml" and "xmlns" can't be rebound.
Note that you must not declare a prefix after you've pushed and popped another Namespace.
prefix
- The prefix to declare, or null for the empty
string.uri
- The Namespace URI to associate with the prefix.getURI(java.lang.String)
,
getDeclaredPrefixAt(int)
String getURI(String prefix)
This method looks up the prefix in the current context. If no mapping is found, this methods will continue lookup in the parent context(s). Use the empty string ("") for the default Namespace.
prefix
- The prefix to look up.String getPrefix(String uri)
This method looks up the namespace URI in the current context. If more than one prefix is currently mapped to the same URI, this method will make an arbitrary selection If no mapping is found, this methods will continue lookup in the parent context(s).
uri
- The namespace URI to look up.getPrefix(java.lang.String)
int getDeclaredPrefixCount()
String getDeclaredPrefixAt(int index)
Enumeration getAllPrefixes()
void reset()
It is necessary to invoke this method before reusing the Namespace support object for a new session.
Note that implementations of this method need to ensure that the declaration of the prefixes "xmlns" and "xml" are available.
Copyright © 2012 JBoss by Red Hat. All Rights Reserved.