com.wm.xmldata

Class XmlNamespaceMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<java.lang.String,java.lang.String>

com.wm.xmldata.XmlNamespaceMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.String>

public class XmlNamespaceMap
extends java.util.HashMap<java.lang.String,java.lang.String>

This class maintains a mapping between prefixes and namespace URIs. It is similar to HashMap but requires a one-to-one relationship between prefix (key) and namespace (value). Any attempt to add an entry that includes a key (prefix) or value (namespace URI) that is already in use results in an error. An additional method putValue() generates a unique prefix. An additional method removeValue() allows a declaration to be removed without knowing the prefix.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
XmlNamespaceMap() Creates an empty namespace map.
XmlNamespaceMap(java.lang.String prefixBase) Creates a XmlNamespaceMap with a specific base name for the generated prefixes.

Method Summary

Modifier and Type	Method and Description
static XmlNamespaceMap	createFromList(java.lang.String[] pairs) Creates an XmlNamespaceMap from a String array containing prefix namespace pairs.
static XmlNamespaceMap	createFromPairs(java.lang.String pairs) Creates an XmlNamespaceMap from a String containing prefix namespace pairs.
java.lang.String	getAsDeclaration() Creates a namespace declaration string in the form {prefix.1 namespace.1 ...
java.lang.String	getAsPairs() Creates a namespace declaration String in the form of pairs: prefix.1 namespace.1 ...
java.lang.String	getDecalredKey(java.lang.String namespace) Returns the declared prefix associated with a namespace.
java.lang.String	getKey(java.lang.String namespace) Returns the prefix associated with a namespace.
java.lang.String	put(java.lang.String prefix, java.lang.String namespace)
void	putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> map)
java.lang.String	putValue(java.lang.String namespace) Adds the namespace declaration using a unique generated prefix.
java.lang.String	removeValue(java.lang.String namespace) Removes the declaration for the specified value (namespace).

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

XmlNamespaceMap

public XmlNamespaceMap(java.lang.String prefixBase)

Creates a XmlNamespaceMap with a specific base name for the generated prefixes. The default value is "ns". The base name is used only when getKey() must generate a prefix for a previously undeclared namespace.

Parameters:

prefixBase - the prefix base

XmlNamespaceMap

public XmlNamespaceMap()

Creates an empty namespace map. The default base prefix is "ns".

Method Detail

getKey

public java.lang.String getKey(java.lang.String namespace)

Returns the prefix associated with a namespace. If the namespace is undeclared, a generated prefix is associated and returned.

Parameters:

namespace - the namespace for which the associated prefix is returned

Returns:

the associated prefix

getDecalredKey

public java.lang.String getDecalredKey(java.lang.String namespace)

Returns the declared prefix associated with a namespace. If the namespace is undeclared, null returned.

Parameters:

namespace - the namespace for which the associated prefix is returned

Returns:

the associated prefix

put

public java.lang.String put(java.lang.String prefix,
                            java.lang.String namespace)

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

put in class java.util.HashMap<java.lang.String,java.lang.String>

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> map)

Specified by:

putAll in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

putAll in class java.util.HashMap<java.lang.String,java.lang.String>

putValue

public java.lang.String putValue(java.lang.String namespace)

Adds the namespace declaration using a unique generated prefix. The base prefix is established by the constructor call to XmlNamespaceMap. Each unique prefix is created by assigning an incrementing suffix of 1, 2, 3 ... etc. to the generated prefix.

Parameters:

namespace - the XML namespace

Returns:

the assigned prefix

Throws:

java.lang.IllegalArgumentException - if the namespace URI is already present as a value.

removeValue

public java.lang.String removeValue(java.lang.String namespace)

Removes the declaration for the specified value (namespace).

Parameters:

namespace - the namespace to remove

Returns:

the associated prefix if defined, null otherwise

createFromList

public static XmlNamespaceMap createFromList(java.lang.String[] pairs)

Creates an XmlNamespaceMap from a String array containing prefix namespace pairs.

Parameters:

pairs - String array with an even number of members

Returns:

an XmlNamespaceMap

createFromPairs

public static XmlNamespaceMap createFromPairs(java.lang.String pairs)

Creates an XmlNamespaceMap from a String containing prefix namespace pairs.

Parameters:

pairs - String in the from: "prefix.1 namespace.1 ... prefix.n namespace.n"

Returns:

an XmlNamespaceMap

getAsPairs

public java.lang.String getAsPairs()

Creates a namespace declaration String in the form of pairs: prefix.1 namespace.1 ... prefix.n namespace.n

Returns:

the namespace declaration

getAsDeclaration

public java.lang.String getAsDeclaration()

Creates a namespace declaration string in the form {prefix.1 namespace.1 ... prefix.n namespace.n}. An empty string is returned if the map is empty.

Returns:

the path declaration