com.sun.identity.saml2.jaxb.assertion.impl.runtime

Class NamespaceContextImpl

java.lang.Object

com.sun.identity.saml2.jaxb.assertion.impl.runtime.NamespaceContextImpl

All Implemented Interfaces:

NamespaceContext2, NamespaceContext

public class NamespaceContextImpl
extends Object
implements NamespaceContext2

Implementation of the NamespaceContext2. This class also provides several utility methods for XMLSerializer-derived classes. The startElement method and the endElement method need to be called appropriately when used. See javadoc for those methods for details.

Constructor Summary

Constructors

Constructor and Description
NamespaceContextImpl(com.sun.xml.bind.marshaller.NamespacePrefixMapper _prefixMapper)

Method Summary

Modifier and Type	Method and Description
String	declareNamespace(String namespaceUri, String preferedPrefix, boolean requirePrefix) Declares a new namespace binding within the current context.
void	endElement() Ends the current element context and gets back to the parent context.
void	endNamespaceDecls() Reconciles the namespace URI/prefix mapping requests since the last startElement method invocation and finalizes them.
com.sun.xml.bind.marshaller.NamespacePrefixMapper	getNamespacePrefixMapper()
String	getNamespaceURI(String prefix) Obtains the namespace URI currently associated to the given prefix.
String	getPrefix(String namespaceUri)
Iterator	getPrefixes(String namespaceUri)
void	iterateDeclaredPrefixes(PrefixCallback callback) Iterates all newly declared namespace prefixes for this element.
void	startElement() Sets the current bindings aside and starts a new element context.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamespaceContextImpl

public NamespaceContextImpl(com.sun.xml.bind.marshaller.NamespacePrefixMapper _prefixMapper)

Method Detail

getNamespacePrefixMapper

public final com.sun.xml.bind.marshaller.NamespacePrefixMapper getNamespacePrefixMapper()

declareNamespace

public String declareNamespace(String namespaceUri,
                               String preferedPrefix,
                               boolean requirePrefix)

Description copied from interface: NamespaceContext2

Declares a new namespace binding within the current context.

The prefix is automatically assigned by MarshallingContext. If a given namespace URI is already declared, nothing happens.

It is NOT an error to declare the same namespace URI more than once.

For marshalling to work correctly, all namespace bindings for an element must be declared between its startElement method and its endAttributes event. Calling the same method with the same parameter between the endAttributes and the endElement returns the same prefix.

Specified by:

declareNamespace in interface NamespaceContext2

Parameters:

requirePrefix - true if this is called for attribute name. false otherwise.

preferedPrefix - If the caller has any particular preference to the prefix, pass that as a parameter. The callee will try to honor it. Set null if there's no particular preference.

Returns:

returns the assigned prefix. If the namespace is bound to the default namespace, null is returned.

getPrefix

public String getPrefix(String namespaceUri)

Specified by:

getPrefix in interface NamespaceContext

getNamespaceURI

public String getNamespaceURI(String prefix)

Obtains the namespace URI currently associated to the given prefix. If no namespace URI is associated, return null.

Specified by:

getNamespaceURI in interface NamespaceContext

getPrefixes

public Iterator getPrefixes(String namespaceUri)

Specified by:

getPrefixes in interface NamespaceContext

startElement

public void startElement()

Sets the current bindings aside and starts a new element context. This method should be called at the beginning of the startElement method of the Serializer implementation.

endNamespaceDecls

public void endNamespaceDecls()

Reconciles the namespace URI/prefix mapping requests since the last startElement method invocation and finalizes them. This method must be called after all the necessary namespace URIs for this element is reported through the declareNamespace method or the getPrefix method.

endElement

public void endElement()

Ends the current element context and gets back to the parent context. This method should be called at the end of the endElement method of derived classes.

iterateDeclaredPrefixes

public void iterateDeclaredPrefixes(PrefixCallback callback)
                             throws SAXException

Iterates all newly declared namespace prefixes for this element.

Throws:

SAXException