Woodstox 6.5.1 · com.ctc.wstx.util.BaseNsContext · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected static final String	UNDECLARED_NS_URI This is the URI returned for default namespace, when it hasn't been explicitly declared; could be either "" or null.

Access	Constructor and Description
public	BaseNsContext()

Modifier and Type	Method and Description
public abstract String	doGetNamespaceURI(String prefix)
public abstract String	doGetPrefix(String nsURI)
public abstract Iterator<String>	doGetPrefixes(String nsURI)
public abstract Iterator<Namespace>	getNamespaces()
public final String	getNamespaceURI(String prefix to look up prefix) Implements javax.xml.namespace.NamespaceContext.getNamespaceURI. Get Namespace URI bound to a prefix in the current scope.
public final String	getPrefix(String URI of Namespace to lookup nsURI) Implements javax.xml.namespace.NamespaceContext.getPrefix. Get prefix bound to Namespace URI in the current scope.
public final Iterator<String>	getPrefixes(String URI of Namespace to lookup nsURI) Implements javax.xml.namespace.NamespaceContext.getPrefixes. Get all prefixes bound to a Namespace URI in the current scope.
public abstract void	outputNamespaceDeclarations(Writer w) Method called by the matching start element class to output all namespace declarations active in current namespace scope, if any.
public abstract void	outputNamespaceDeclarations(XMLStreamWriter w)

Field Detail

UNDECLARED_NS_URI	back to summary
protected static final String UNDECLARED_NS_URI This is the URI returned for default namespace, when it hasn't been explicitly declared; could be either "" or null.

Constructor Detail

BaseNsContext	back to summary
public BaseNsContext()

Method Detail

doGetNamespaceURI	back to summary
public abstract String doGetNamespaceURI(String prefix)

doGetPrefix	back to summary
public abstract String doGetPrefix(String nsURI)

doGetPrefixes	back to summary
public abstract Iterator<String> doGetPrefixes(String nsURI)

getNamespaces	back to summary
public abstract Iterator<Namespace> getNamespaces()

getNamespaceURI back to summary

public final String getNamespaceURI(String prefix)

Implements javax.xml.namespace.NamespaceContext.getNamespaceURI.

Doc from javax.xml.namespace.NamespaceContext.getNamespaceURI.

Get Namespace URI bound to a prefix in the current scope.

When requesting a Namespace URI by prefix, the following table describes the returned Namespace URI value for all possible prefix values:

Return value for specified prefixes
prefix parameter	Namespace URI return value
`DEFAULT_NS_PREFIX` ("")	default Namespace URI in the current scope or `XMLConstants.NULL_NS_URI("")` when there is no default Namespace URI in the current scope
bound prefix	Namespace URI bound to prefix in current scope
unbound prefix	`XMLConstants.NULL_NS_URI("")`
`XMLConstants.XML_NS_PREFIX` ("xml")	`XMLConstants.XML_NS_URI` ("http://www.w3.org/XML/1998/namespace")
`XMLConstants.XMLNS_ATTRIBUTE` ("xmlns")	`XMLConstants.XMLNS_ATTRIBUTE_NS_URI` ("http://www.w3.org/2000/xmlns/")
`null`	`IllegalArgumentException` is thrown

Parameters

prefix:String: prefix to look up

Returns:String

Namespace URI bound to prefix in the current scope

Annotations

@Override

getPrefix back to summary

public final String getPrefix(String nsURI)

Implements javax.xml.namespace.NamespaceContext.getPrefix.

Doc from javax.xml.namespace.NamespaceContext.getPrefix.

Get prefix bound to Namespace URI in the current scope.

To get all prefixes bound to a Namespace URI in the current scope, use getPrefixes(String namespaceURI).

When requesting a prefix by Namespace URI, the following table describes the returned prefix value for all Namespace URI values:

Return value for specified Namespace URIs
Namespace URI parameter	prefix value returned
`<default Namespace URI>`	`XMLConstants.DEFAULT_NS_PREFIX` ("")
bound Namespace URI	prefix bound to Namespace URI in the current scope, if multiple prefixes are bound to the Namespace URI in the current scope, a single arbitrary prefix, whose choice is implementation dependent, is returned
unbound Namespace URI	`null`
`XMLConstants.XML_NS_URI` ("http://www.w3.org/XML/1998/namespace")	`XMLConstants.XML_NS_PREFIX` ("xml")
`XMLConstants.XMLNS_ATTRIBUTE_NS_URI` ("http://www.w3.org/2000/xmlns/")	`XMLConstants.XMLNS_ATTRIBUTE` ("xmlns")
`null`	`IllegalArgumentException` is thrown

Parameters

nsURI:String: URI of Namespace to lookup

Returns:String

prefix bound to Namespace URI in current context

Annotations

@Override

getPrefixes back to summary

public final Iterator<String> getPrefixes(String nsURI)

Implements javax.xml.namespace.NamespaceContext.getPrefixes.

Doc from javax.xml.namespace.NamespaceContext.getPrefixes.

Get all prefixes bound to a Namespace URI in the current scope.

An Iterator over String elements is returned in an arbitrary, implementation dependent, order.

The Iterator is not modifiable. e.g. the remove() method will throw UnsupportedOperationException.

When requesting prefixes by Namespace URI, the following table describes the returned prefixes value for all Namespace URI values:

Return value for specified Namespace URIs
Namespace URI parameter	prefixes value returned
bound Namespace URI, including the `<default Namespace URI>`	`Iterator` over prefixes bound to Namespace URI in the current scope in an arbitrary, implementation dependent, order
unbound Namespace URI	empty `Iterator`
`XMLConstants.XML_NS_URI` ("http://www.w3.org/XML/1998/namespace")	`Iterator` with one element set to `XMLConstants.XML_NS_PREFIX` ("xml")
`XMLConstants.XMLNS_ATTRIBUTE_NS_URI` ("http://www.w3.org/2000/xmlns/")	`Iterator` with one element set to `XMLConstants.XMLNS_ATTRIBUTE` ("xmlns")
`null`	`IllegalArgumentException` is thrown

Parameters

nsURI:String: URI of Namespace to lookup

Returns:Iterator<String>

Iterator for all prefixes bound to the Namespace URI in the current scope

Annotations

@Override

outputNamespaceDeclarations	back to summary
public abstract void outputNamespaceDeclarations(Writer w) throws IOException Method called by the matching start element class to output all namespace declarations active in current namespace scope, if any.

outputNamespaceDeclarations	back to summary
public abstract void outputNamespaceDeclarations(XMLStreamWriter w) throws XMLStreamException

public abstract Class BaseNsContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail