Package org.htmlunit.cyberneko.xerces.xni

Interface NamespaceContext

  • All Known Implementing Classes:
    NamespaceBinder.NamespaceSupport, NamespaceSupport
    public interface NamespaceContext
    Represents an interface to query namespace information.

    The prefix and namespace must be identical references for equal strings, thus each string should be internalized (@see String.intern()).

    Author:
    Andy Clark, IBM

    • Field Detail

      • XML_URI

        static final String XML_URI
        The XML Namespace ("http://www.w3.org/XML/1998/namespace"). This is the Namespace URI that is automatically mapped to the "xml" prefix.
        See Also:
        Constant Field Values

      • XMLNS_URI

        static final String XMLNS_URI
        XML Information Set REC all namespace attributes (including those named xmlns, whose [prefix] property has no value) have a namespace URI of http://www.w3.org/2000/xmlns/
        See Also:
        Constant Field Values

    • Method Detail

      • pushContext

        void pushContext()
        Start a new Namespace context.

        A new context should be pushed at the beginning of each XML element: the new context will automatically inherit the declarations of its parent context, but it will also keep track of which declarations were made within this context.

        See Also:
        popContext()

      • popContext

        void popContext()
        Revert to the previous Namespace context.

        The context should be popped at the end of each XML element. After popping the context, all Namespace prefix mappings that were previously in force are restored.

        Users must not attempt to declare additional Namespace prefixes after popping a context, unless you push another context first.

        See Also:
        pushContext()

      • declarePrefix

        boolean declarePrefix​(String prefix,
                      String uri)
        Declare a Namespace prefix.

        This method declares a prefix in the current Namespace context; the prefix will remain in force until this context is popped, unless it is shadowed in a descendant context.

        Note that to declare a default Namespace, use the empty string. The prefixes "xml" and "xmlns" can't be rebound.

        Note that you must not declare a prefix after you've pushed and popped another Namespace.

        Parameters:
        prefix - The prefix to declare, or null for the empty string.
        uri - The Namespace URI to associate with the prefix.
        Returns:
        true if the prefix was legal, false otherwise
        See Also:
        getURI(java.lang.String), getDeclaredPrefixAt(int)

      • getURI

        String getURI​(String prefix)
        Look up a prefix and get the currently-mapped Namespace URI.

        This method looks up the prefix in the current context. If no mapping is found, this methods will continue lookup in the parent context(s). Use the empty string ("") for the default Namespace.

        Parameters:
        prefix - The prefix to look up.
        Returns:
        The associated Namespace URI, or null if the prefix is undeclared in this context.

      • getDeclaredPrefixCount

        int getDeclaredPrefixCount()
        Returns:
        a count of locally declared prefixes, including the default prefix if bound.

      • getDeclaredPrefixAt

        String getDeclaredPrefixAt​(int index)
        Parameters:
        index - the index pos
        Returns:
        the prefix at the specified index in the current context.

      • reset

        void reset()
        Reset this Namespace support object for reuse.

        It is necessary to invoke this method before reusing the Namespace support object for a new session.

        Note that implementations of this method need to ensure that the declaration of the prefixes "xmlns" and "xml" are available.