Package org.apache.ws.commons.util
Class NamespaceContextImpl
java.lang.Object
org.apache.ws.commons.util.NamespaceContextImpl
- All Implemented Interfaces:
NamespaceContext
Default implementation of
NamespaceContext
.-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncheckContext
(int i) This method is used to restore the namespace state after an element is created.void
endPrefixMapping
(String pPrefix) Removes the declaration of the prefix, which has been defined last.getAttributePrefix
(String pURI) Returns a non-empty prefix currently mapped to the given URL or null, if there is no such mapping.int
Returns the current number of assigned prefixes.getNamespaceURI
(String pPrefix) Given a prefix, returns the URI to which the prefix is currently mapped or null, if there is no such mapping.Returns a prefix currently mapped to the given URI or null, if there is no such mapping.Returns a list of all prefixes, which are currently declared, in the order of declaration.getPrefixes
(String pURI) Returns a collection to all prefixes bound to the given namespace URI.boolean
isPrefixDeclared
(String pPrefix) Returns whether a given prefix is currently declared.void
reset()
Resets the NamespaceSupport's state.void
startPrefixMapping
(String pPrefix, String pURI) Declares a new prefix.
-
Field Details
-
prefixList
-
cachedPrefix
-
cachedURI
-
-
Constructor Details
-
NamespaceContextImpl
public NamespaceContextImpl()
-
-
Method Details
-
reset
public void reset()Resets the NamespaceSupport's state. Allows reusing the object. -
startPrefixMapping
Declares a new prefix. Typically called from withininvalid reference
org.xml.sax.ContextHandler#startPrefixMapping(java.lang.String, java.lang.String)
- Throws:
IllegalArgumentException
- Prefix or URI are null.
-
endPrefixMapping
Removes the declaration of the prefix, which has been defined last. Typically called from withininvalid reference
org.xml.sax.ContextHandler#endPrefixMapping(java.lang.String)
- Throws:
IllegalArgumentException
- The prefix is null.IllegalStateException
- The prefix is not the prefix, which has been defined last. In other words, the calls tostartPrefixMapping(String, String)
, andendPrefixMapping(String)
aren't in LIFO order.
-
getNamespaceURI
Given a prefix, returns the URI to which the prefix is currently mapped or null, if there is no such mapping.Note: This methods behaviour is precisely defined by
NamespaceContext.getNamespaceURI(java.lang.String)
.- Specified by:
getNamespaceURI
in interfaceNamespaceContext
- Parameters:
pPrefix
- The prefix in question
-
getPrefix
Returns a prefix currently mapped to the given URI or null, if there is no such mapping. This method may be used to find a possible prefix for an elements namespace URI. For attributes you should usegetAttributePrefix(String)
. Note: This methods behaviour is precisely defined byNamespaceContext.getPrefix(java.lang.String)
.- Specified by:
getPrefix
in interfaceNamespaceContext
- Parameters:
pURI
- The namespace URI in question- Throws:
IllegalArgumentException
- The namespace URI is null.
-
getAttributePrefix
Returns a non-empty prefix currently mapped to the given URL or null, if there is no such mapping. This method may be used to find a possible prefix for an attributes namespace URI. For elements you should usegetPrefix(String)
.- Parameters:
pURI
- Thhe namespace URI in question- Throws:
IllegalArgumentException
- The namespace URI is null.
-
getPrefixes
Returns a collection to all prefixes bound to the given namespace URI. Note: This methods behaviour is precisely defined byNamespaceContext.getPrefixes(java.lang.String)
.- Specified by:
getPrefixes
in interfaceNamespaceContext
- Parameters:
pURI
- The namespace prefix in question
-
isPrefixDeclared
Returns whether a given prefix is currently declared. -
getContext
public int getContext()Returns the current number of assigned prefixes. Note, that a prefix may be assigned in several nested elements, in which case every assignment is counted.
This method is typically called before invoking the methodContentHandler.startElement(String, String, String, org.xml.sax.Attributes)
. The return value is used as a saveable state. After invokingContentHandler.endElement(String, String, String)
, the state is restored by callingcheckContext(int)
. -
checkContext
This method is used to restore the namespace state after an element is created. It takes as input a state, as returned bygetContext()
.
For any prefix, which was since saving the state, the prefix is returned and deleted from the internal list. In other words, a typical use looks like this:NamespaceSupport nss; ContentHandler h; int context = nss.getContext(); h.startElement("foo", "bar", "f:bar", new AttributesImpl()); ... h.endElement("foo", "bar", "f:bar"); for (;;) { String prefix = nss.checkContext(context); if (prefix == null) { break; } h.endPrefixMapping(prefix); }
-
getPrefixes
Returns a list of all prefixes, which are currently declared, in the order of declaration. Duplicates are possible, if a prefix has been assigned to more than one URI, or repeatedly to the same URI.
-