com.phloc.commons.xml.namespace

Class MapBasedNamespaceContext

java.lang.Object

com.phloc.commons.xml.namespace.AbstractNamespaceContext

com.phloc.commons.xml.namespace.MapBasedNamespaceContext

All Implemented Interfaces:

IIterableNamespaceContext, Serializable, NamespaceContext

@NotThreadSafe
public class MapBasedNamespaceContext
extends AbstractNamespaceContext

Represents a namespace context a 1:n (namespace:prefix) mapping.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MapBasedNamespaceContext()

Method Summary

Methods

Modifier and Type	Method and Description
MapBasedNamespaceContext	addMapping(String sPrefix, String sNamespaceURI) Add a new prefix to namespace mapping.
protected String	getCustomNamespaceURI(String sPrefix)
protected String	getCustomPrefix(String sNamespaceURI)
protected Iterator<String>	getCustomPrefixes(String sNamespaceURI)
String	getDefaultNamespaceURI()
int	getMappingCount()
Map<String,String>	getPrefixToNamespaceURIMap() Get all contained mappings.
boolean	hasAnyMapping()
MapBasedNamespaceContext	setDefaultNamespaceURI(String sNamespaceURI) Set the default namespace URL
String	toString()

Methods inherited from class com.phloc.commons.xml.namespace.AbstractNamespaceContext

getNamespaceURI, getPrefix, getPrefixes

Methods inherited from class java.lang.Object

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

Constructor Detail

MapBasedNamespaceContext

public MapBasedNamespaceContext()

Method Detail

getDefaultNamespaceURI

@Nullable
public String getDefaultNamespaceURI()

Specified by:

getDefaultNamespaceURI in class AbstractNamespaceContext

setDefaultNamespaceURI

@Nonnull
public MapBasedNamespaceContext setDefaultNamespaceURI(@Nonnull@Nonempty
                                                      String sNamespaceURI)

Set the default namespace URL

Parameters:

sNamespaceURI - The namespace URI to be used as the default. May neither be null nor empty.

Returns:

this

addMapping

@Nonnull
public MapBasedNamespaceContext addMapping(@Nonnull
                                          String sPrefix,
                                          @Nonnull@Nonempty
                                          String sNamespaceURI)

Add a new prefix to namespace mapping.

Parameters:

sPrefix - The prefix to be used. May not be null. If it equals XMLConstants.DEFAULT_NS_PREFIX that the namespace is considered to be the default one.

sNamespaceURI - The namespace URI to be mapped. May neither be null nor empty.

Returns:

this

getCustomPrefixes

@Nullable
protected Iterator<String> getCustomPrefixes(@Nonnull
                                          String sNamespaceURI)

Specified by:

getCustomPrefixes in class AbstractNamespaceContext

getCustomPrefix

@Nullable
protected String getCustomPrefix(@Nonnull
                              String sNamespaceURI)

Specified by:

getCustomPrefix in class AbstractNamespaceContext

getCustomNamespaceURI

@Nullable
protected String getCustomNamespaceURI(@Nonnull
                                    String sPrefix)

Specified by:

getCustomNamespaceURI in class AbstractNamespaceContext

getPrefixToNamespaceURIMap

@Nonnull
@ReturnsMutableCopy
public Map<String,String> getPrefixToNamespaceURIMap()

Description copied from interface: IIterableNamespaceContext

Get all contained mappings.

Returns:

The map with all prefixes mapped to the namespace URIs.

hasAnyMapping

public boolean hasAnyMapping()

getMappingCount

@Nonnegative
public int getMappingCount()

toString

public String toString()

Overrides:

toString in class Object