Package com.helger.xml.namespace

Class MapBasedNamespaceContext

java.lang.Object

com.helger.xml.namespace.AbstractNamespaceContext

com.helger.xml.namespace.MapBasedNamespaceContext

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<MapBasedNamespaceContext>, IIterableNamespaceContext, INamespaceContext, Serializable, NamespaceContext

@NotThreadSafe
public class MapBasedNamespaceContext
extends AbstractNamespaceContext
implements com.helger.commons.lang.ICloneable<MapBasedNamespaceContext>

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

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MapBasedNamespaceContext()	Default constructor.
MapBasedNamespaceContext(IIterableNamespaceContext aOther)	Constructor to copy from another IIterableNamespaceContext
MapBasedNamespaceContext(MapBasedNamespaceContext aOther)	Copy constructor.
MapBasedNamespaceContext(Map<String,String> aOther)	Constructor with prefix to namespace URL map

Method Summary

Modifier and Type	Method	Description
MapBasedNamespaceContext	addDefaultNamespaceURI(String sNamespaceURI)	Add the default namespace URL
MapBasedNamespaceContext	addMapping(String sPrefix, String sNamespaceURI)	Add a new prefix to namespace mapping.
MapBasedNamespaceContext	addMappings(IIterableNamespaceContext aOther)
MapBasedNamespaceContext	addMappings(Map<String,String> aOther)
com.helger.commons.state.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()
com.helger.commons.collection.impl.ICommonsOrderedMap<String,String>	getPrefixToNamespaceURIMap()	Get all contained mappings.
boolean	hasAnyMapping()
int	hashCode()
boolean	isNamespaceURIMapped(String sNamespaceURI)
boolean	isPrefixMapped(String sPrefix)
com.helger.commons.state.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)
MapBasedNamespaceContext	setMappings(Map<String,String> aOther)
String	toString()

Methods inherited from class com.helger.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()

Default constructor.

MapBasedNamespaceContext

public MapBasedNamespaceContext(@Nullable
                                MapBasedNamespaceContext aOther)

Copy constructor.

Parameters:

aOther - Object to copy from. May be null.

MapBasedNamespaceContext

public MapBasedNamespaceContext(@Nullable
                                IIterableNamespaceContext aOther)

Constructor to copy from another IIterableNamespaceContext

Parameters:

aOther - Object to copy the data from. May be null.

MapBasedNamespaceContext

public MapBasedNamespaceContext(@Nullable
                                Map<String,String> aOther)

Constructor with prefix to namespace URL map

Parameters:

aOther - Map with prefix to namespace URL. May be null.

Since:

8.5.3

Method Detail

getDefaultNamespaceURI

@Nullable
public String getDefaultNamespaceURI()

Specified by:

getDefaultNamespaceURI in class AbstractNamespaceContext

addMapping

@Nonnull
public final 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 final 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)

addMappings

@Nonnull
public final MapBasedNamespaceContext addMappings(@Nullable
                                                  Map<String,String> aOther)

setMappings

@Nonnull
public final MapBasedNamespaceContext setMappings(@Nullable
                                                  Map<String,String> aOther)

addDefaultNamespaceURI

@Nonnull
public final MapBasedNamespaceContext addDefaultNamespaceURI(@Nonnull
                                                             String sNamespaceURI)

Add the default namespace URL

Parameters:

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

Returns:

this

setDefaultNamespaceURI

@Nonnull
public final 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

removeMapping

@Nonnull
public com.helger.commons.state.EChange removeMapping(@Nullable
                                                      String sPrefix)

isPrefixMapped

public boolean isPrefixMapped(@Nullable
                              String sPrefix)

isNamespaceURIMapped

public boolean isNamespaceURIMapped(@Nullable
                                    String sNamespaceURI)

clear

@Nonnull
public com.helger.commons.state.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 com.helger.commons.collection.impl.ICommonsOrderedMap<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 com.helger.commons.lang.ICloneable<MapBasedNamespaceContext>

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