com.helger.commons.xml.namespace

Class MapBasedNamespaceContext

java.lang.Object

com.helger.commons.xml.namespace.AbstractNamespaceContext

com.helger.commons.xml.namespace.MapBasedNamespaceContext

All Implemented Interfaces:

ICloneable<MapBasedNamespaceContext>, IIterableNamespaceContext, Serializable, NamespaceContext

@NotThreadSafe
public class MapBasedNamespaceContext
extends AbstractNamespaceContext
implements ICloneable<MapBasedNamespaceContext>

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

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MapBasedNamespaceContext()
MapBasedNamespaceContext(IIterableNamespaceContext aOther)
MapBasedNamespaceContext(MapBasedNamespaceContext aOther)

Method Summary

Modifier and Type	Method and Description
MapBasedNamespaceContext	addMapping(String sPrefix, String sNamespaceURI) Add a new prefix to namespace mapping.
MapBasedNamespaceContext	addMappings(IIterableNamespaceContext aOther)
EChange	clear()
boolean	equals(Object o)
MapBasedNamespaceContext	getClone()
String	getCustomNamespaceURI(String sPrefix)
String	getCustomPrefix(String sNamespaceURI)
Iterator<String>	getCustomPrefixes(String sNamespaceURI)
String	getDefaultNamespaceURI()
int	getMappingCount()
Map<String,String>	getPrefixToNamespaceURIMap() Get all contained mappings.
boolean	hasAnyMapping()
int	hashCode()
EChange	removeMapping(String sPrefix)
MapBasedNamespaceContext	setDefaultNamespaceURI(String sNamespaceURI) Set the default namespace URL
MapBasedNamespaceContext	setMapping(String sPrefix, String sNamespaceURI) Add a new prefix to namespace mapping.
MapBasedNamespaceContext	setMappings(IIterableNamespaceContext aOther)
String	toString()

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

getNamespaceURI, getPrefix, getPrefixes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MapBasedNamespaceContext

public MapBasedNamespaceContext()

MapBasedNamespaceContext

public MapBasedNamespaceContext(@Nullable
                                MapBasedNamespaceContext aOther)

MapBasedNamespaceContext

public MapBasedNamespaceContext(@Nullable
                                IIterableNamespaceContext aOther)

Method Detail

getDefaultNamespaceURI

@Nullable
public String getDefaultNamespaceURI()

Specified by:

getDefaultNamespaceURI in class AbstractNamespaceContext

setDefaultNamespaceURI

@Nonnull
public MapBasedNamespaceContext setDefaultNamespaceURI(@Nonnull
                                                                 String sNamespaceURI)

Set the default namespace URL

Parameters:

sNamespaceURI - The namespace URI to be used as the default. May not be null but maybe empty.

Returns:

this

addMapping

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

Add a new prefix to namespace mapping. If a prefix is already present, an IllegalArgumentException is thrown.

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 not be null but maybe empty.

Returns:

this

Throws:

IllegalArgumentException - If another mapping for the passed prefix is already present

See Also:

setMapping(String, String)

setMapping

@Nonnull
public MapBasedNamespaceContext setMapping(@Nonnull
                                                     String sPrefix,
                                                     @Nonnull
                                                     String sNamespaceURI)

Add a new prefix to namespace mapping. If a prefix is already present it is overwritten.

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 not be null but maybe empty.

Returns:

this

See Also:

addMapping(String, String)

addMappings

@Nonnull
public final MapBasedNamespaceContext addMappings(@Nullable
                                                            IIterableNamespaceContext aOther)

setMappings

@Nonnull
public final MapBasedNamespaceContext setMappings(@Nullable
                                                            IIterableNamespaceContext aOther)

removeMapping

@Nonnull
public EChange removeMapping(@Nullable
                                       String sPrefix)

clear

@Nonnull
public EChange clear()

getCustomPrefixes

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

Specified by:

getCustomPrefixes in class AbstractNamespaceContext

getCustomPrefix

@Nullable
public String getCustomPrefix(@Nonnull
                                         String sNamespaceURI)

Specified by:

getCustomPrefix in class AbstractNamespaceContext

getCustomNamespaceURI

@Nullable
public 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.

Specified by:

getPrefixToNamespaceURIMap in interface IIterableNamespaceContext

Returns:

The map with all prefixes mapped to the namespace URIs.

hasAnyMapping

public boolean hasAnyMapping()

getMappingCount

@Nonnegative
public int getMappingCount()

getClone

@Nonnull
 @ReturnsMutableCopy
public MapBasedNamespaceContext getClone()

Specified by:

getClone in interface ICloneable<MapBasedNamespaceContext>

Returns:

A 100% deep-copy of the implementing class.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object