com.phloc.commons.xml.serialize

Class AbstractSerializerPhloc.NamespaceStack

java.lang.Object

com.phloc.commons.xml.serialize.AbstractSerializerPhloc.NamespaceStack

Enclosing class:

AbstractSerializerPhloc<NODETYPE>

protected static final class AbstractSerializerPhloc.NamespaceStack
extends Object

Contains the hierarchy of XML namespaces within a document structure. Important: null namespace URIs are different from empty namespace URIs!

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AbstractSerializerPhloc.NamespaceStack(NamespaceContext aNamespaceCtx)

Method Summary

Methods

Modifier and Type	Method and Description
void	addNamespaceMapping(String sPrefix, String sNamespaceURI)
String	createUniquePrefix() Create a new unique namespace prefix.
String	getDefaultNamespaceURI()
String	getMappedPrefix(String sNamespaceURI) Check if the passed namespace URI is mapped in the namespace context.
String	getUsedPrefixOfNamespace(String sNamespaceURI) Resolve the given namespace URI to a prefix.
void	pop()
void	push(Map<String,String> aAttrs) Start a new namespace level.
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSerializerPhloc.NamespaceStack

public AbstractSerializerPhloc.NamespaceStack(@Nullable
                                      NamespaceContext aNamespaceCtx)

Method Detail

push

public void push(@Nullable
        Map<String,String> aAttrs)

Start a new namespace level.

Parameters:

aAttrs - Existing attributes from which XML namespace prefix mappings should be extracted. May be null.

addNamespaceMapping

public void addNamespaceMapping(@Nullable
                       String sPrefix,
                       @Nonnull@Nonempty
                       String sNamespaceURI)

pop

public void pop()

size

@Nonnegative
public int size()

getDefaultNamespaceURI

@Nullable
public String getDefaultNamespaceURI()

Returns:

The namespace URI that is currently active in the stack. May be null for no specific namespace.

getUsedPrefixOfNamespace

@Nullable
public String getUsedPrefixOfNamespace(@Nonnull
                                       String sNamespaceURI)

Resolve the given namespace URI to a prefix.

Parameters:

sNamespaceURI - The namespace URI to resolve. May not be null. Pass in an empty string for an empty namespace URI!

Returns:

null if no namespace prefix is required.

getMappedPrefix

@Nullable
public String getMappedPrefix(@Nonnull
                              String sNamespaceURI)

Check if the passed namespace URI is mapped in the namespace context.

Parameters:

sNamespaceURI - The namespace URI to check. May not be null.

Returns:

null if no namespace context mapping is present

createUniquePrefix

@Nullable
public String createUniquePrefix()

Create a new unique namespace prefix.

Returns:

null or empty if the default namespace is available, the prefix otherwise.