com.objsys.xbinder.runtime

Class XBXmlNamespaceContextImpl

java.lang.Object

com.objsys.xbinder.runtime.XBXmlNamespaceContextImpl

public class XBXmlNamespaceContextImpl
extends java.lang.Object

Represents a mapping between namespaces and prefixes. A prefix may map only to a single namespace. A namespace may be bound to multiple prefixes. The default namespace is mapped by prefix XBConstants.DEFAULT_NS_PREFIX. By default, the default namespace is XBConstants.NULL_NS_URI. XBConstants.NULL_NS_URI can only have a single prefix: XBConstants.DEFAULT_NS_PREFIX.

Constructor Summary

Constructors

Constructor and Description
XBXmlNamespaceContextImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultNamespaceURI() Return the default namespace (the namespace DEFAULT_NS_PREFIX is mapped to).
java.lang.String	getExistingPrefix(java.lang.String namespaceURI) Return a non-empty prefix (not XBConstants.DEFAULT_NS_PREFIX) for the given namespace URI.
java.lang.String	getNamespaceURI(java.lang.String prefix) Return the namespace URI that the given prefix is mapped to.
java.lang.String	getPrefix(java.lang.String namespaceURI) Return a prefix for the given namespace URI.
boolean	isDefaultNamespaceURI(java.lang.String namespaceURI) Return true if the given namespace is currently the default namespace (ie, XBConstants.DEFAULT_NS_PREFIX is mapped to this URI)
void	popPrefix(java.lang.String prefix) Remove a prefix to namespace mapping from the stack.
void	pushPrefix(java.lang.String namespaceURI, java.lang.String prefix) Map the given prefix to the given namespace.
java.lang.String	pushUniquePrefix(java.lang.String namespaceURI, java.lang.String preferredPrefix) Push a unique prefix for the given namespace.

Methods inherited from class java.lang.Object

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

Constructor Detail

XBXmlNamespaceContextImpl

public XBXmlNamespaceContextImpl()

Method Detail

popPrefix

public void popPrefix(java.lang.String prefix)

Remove a prefix to namespace mapping from the stack. Restore any previous namespace that the prefix mapped to. It is an error if you attempt to pop a prefix more times than it has been pushed.

pushPrefix

public void pushPrefix(java.lang.String namespaceURI,
                       java.lang.String prefix)

Map the given prefix to the given namespace.

Parameters:

namespaceURI - May not be null. May be empty only if prefix is not empty.

prefix - May not be null. Use empty string for default namespace.

pushUniquePrefix

public java.lang.String pushUniquePrefix(java.lang.String namespaceURI,
                                         java.lang.String preferredPrefix)

Push a unique prefix for the given namespace.

Parameters:

preferredPrefix - A prefix that would be preferred, if available.

Returns:

the unique prefix that was generated and mapped to the namespace

getDefaultNamespaceURI

public java.lang.String getDefaultNamespaceURI()

Return the default namespace (the namespace DEFAULT_NS_PREFIX is mapped to). This may be XBConstants.NULL_NS_URI.

getExistingPrefix

public java.lang.String getExistingPrefix(java.lang.String namespaceURI)

Return a non-empty prefix (not XBConstants.DEFAULT_NS_PREFIX) for the given namespace URI. If one or more such prefixes are mapped to the URI, one of them will be returned. Otherwise, null is returned.

Parameters:

namespaceURI -

Returns:

getNamespaceURI

public java.lang.String getNamespaceURI(java.lang.String prefix)

Return the namespace URI that the given prefix is mapped to. Return XBConstants.NULL_NS_URI if it is not mapped to any URI

Parameters:

prefix -

getPrefix

public java.lang.String getPrefix(java.lang.String namespaceURI)

Return a prefix for the given namespace URI. If one or more prefixes other than XBConstants.DEFAULT_NS_PREFIX is mapped to the URI, one of these will be returned. Otherwise, a generated prefix will be automatically mapped to the URI and returned.

Parameters:

namespaceURI -

Returns:

isDefaultNamespaceURI

public boolean isDefaultNamespaceURI(java.lang.String namespaceURI)

Return true if the given namespace is currently the default namespace (ie, XBConstants.DEFAULT_NS_PREFIX is mapped to this URI)

Parameters:

namespaceURI -

Returns: