Class XmlNamespaceDictionary (1.42.3)

Stay organized with collections Save and categorize content based on your preferences.
public final class XmlNamespaceDictionary

Beta
Thread-safe XML namespace dictionary that provides a one-to-one map of namespace alias to URI.

Implementation is thread-safe. For maximum efficiency, applications should use a single globally-shared instance of the XML namespace dictionary.

A namespace alias is uniquely mapped to a single namespace URI, and a namespace URI is uniquely mapped to a single namespace alias. In other words, it is not possible to have duplicates.

Sample usage:


 static final XmlNamespaceDictionary DICTIONARY = new XmlNamespaceDictionary()
 .set("", "http://www.w3.org/2005/Atom")
 .set("activity", "http://activitystrea.ms/spec/1.0/")
 .set("georss", "http://www.georss.org/georss")
 .set("media", "http://search.yahoo.com/mrss/")
 .set("thr", "http://purl.org/syndication/thread/1.0");
 

Inheritance

Object > XmlNamespaceDictionary

Constructors

XmlNamespaceDictionary()

public XmlNamespaceDictionary()

Methods

getAliasForUri(String uri)

public synchronized String getAliasForUri(String uri)

Returns the namespace alias (or "" for the default namespace) for the given namespace URI.

Parameter
NameDescription
uriString

namespace URI

Returns
TypeDescription
String

getAliasToUriMap()

public synchronized Map<String,String> getAliasToUriMap()

Returns an unmodified set of map entries for the map from namespace alias (or "" for the default namespace) to namespace URI.

Returns
TypeDescription
Map<String,String>

getUriForAlias(String alias)

public synchronized String getUriForAlias(String alias)

Returns the namespace URI for the given namespace alias (or "" for the default namespace).

Parameter
NameDescription
aliasString

namespace alias (or "" for the default namespace)

Returns
TypeDescription
String

getUriToAliasMap()

public synchronized Map<String,String> getUriToAliasMap()

Returns an unmodified set of map entries for the map from namespace URI to namespace alias (or "" for the default namespace).

Returns
TypeDescription
Map<String,String>

serialize(XmlSerializer serializer, String elementName, Object element)

public void serialize(XmlSerializer serializer, String elementName, Object element)

Shows a debug string representation of an element data object of key/value pairs.

Parameters
NameDescription
serializerorg.xmlpull.v1.XmlSerializer
elementNameString

XML element local name prefixed by its namespace alias

elementObject

element data object (GenericXml, Map, or any object with public fields)

Exceptions
TypeDescription
IOException

I/O exception

serialize(XmlSerializer serializer, String elementNamespaceUri, String elementLocalName, Object element)

public void serialize(XmlSerializer serializer, String elementNamespaceUri, String elementLocalName, Object element)

Shows a debug string representation of an element data object of key/value pairs.

Parameters
NameDescription
serializerorg.xmlpull.v1.XmlSerializer
elementNamespaceUriString

XML namespace URI or null for no namespace

elementLocalNameString

XML local name

elementObject

element data object (GenericXml, Map, or any object with public fields)

Exceptions
TypeDescription
IOException

I/O exception

set(String alias, String uri)

public synchronized XmlNamespaceDictionary set(String alias, String uri)

Adds a namespace of the given alias and URI.

If the uri is null, the namespace alias will be removed. Similarly, if the alias is null, the namespace URI will be removed. Otherwise, if the alias is already mapped to a different URI, it will be remapped to the new URI. Similarly, if a URI is already mapped to a different alias, it will be remapped to the new alias.

Parameters
NameDescription
aliasString

alias or null to remove the namespace URI

uriString

namespace URI or null to remove the namespace alias

Returns
TypeDescription
XmlNamespaceDictionary

this namespace dictionary

toStringOf(String elementName, Object element)

public String toStringOf(String elementName, Object element)

Shows a debug string representation of an element data object of key/value pairs.

Parameters
NameDescription
elementNameString

optional XML element local name prefixed by its namespace alias -- for example "atom:entry" -- or null to make up something

elementObject

element data object (GenericXml, Map, or any object with public fields)

Returns
TypeDescription
String