ohair@286: /*
mkos@408:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.org.jvnet.staxex;
ohair@286: 
ohair@286: import javax.xml.namespace.NamespaceContext;
ohair@286: import java.util.Iterator;
ohair@286: 
ohair@286: /**
ohair@286:  * Extended {@link NamespaceContext}.
ohair@286:  *
ohair@286:  * @author Kohsuke Kawaguchi
ohair@286:  * @author Paul Sandoz
ohair@286:  */
ohair@286: public interface NamespaceContextEx extends NamespaceContext, Iterable<NamespaceContextEx.Binding> {
ohair@286: 
ohair@286:     /**
ohair@286:      * Iterates all the in-scope namespace bindings.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * This method enumerates all the active in-scope namespace bindings.
ohair@286:      * This does not include implicit bindings, such as
ohair@286:      * <tt>"xml"->"http://www.w3.org/XML/1998/namespace"</tt>
ohair@286:      * or <tt>""->""</tt> (the implicit default namespace URI.)
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * The returned iterator may not include the same prefix more than once.
ohair@286:      * For example, the returned iterator may only contain <tt>f=ns2</tt>
ohair@286:      * if the document is as follows and this method is used at the bar element.
ohair@286:      *
ohair@286:      * <pre><xmp>
ohair@286:      * <foo xmlns:f='ns1'>
ohair@286:      *   <bar xmlns:f='ns2'>
ohair@286:      *     ...
ohair@286:      * </xmp></pre>
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * The iteration may be done in no particular order.
ohair@286:      *
ohair@286:      * @return
ohair@286:      *      may return an empty iterator, but never null.
ohair@286:      */
ohair@286:     Iterator<Binding> iterator();
ohair@286: 
ohair@286:     /**
ohair@286:      * Prefix to namespace URI binding.
ohair@286:      */
ohair@286:     interface Binding {
ohair@286:         /**
ohair@286:          * Gets the prefix.
ohair@286:          *
ohair@286:          * <p>
ohair@286:          * The default namespace URI is represented by using an
ohair@286:          * empty string "", not null.
ohair@286:          *
ohair@286:          * @return
ohair@286:          *      never null. String like "foo", "ns12", or "".
ohair@286:          */
ohair@286:         String getPrefix();
ohair@286: 
ohair@286:         /**
ohair@286:          * Gets the namespace URI.
ohair@286:          *
ohair@286:          * <p>
ohair@286:          * The empty namespace URI is represented by using
ohair@286:          * an empty string "", not null.
ohair@286:          *
ohair@286:          * @return
ohair@286:          *      never null. String like "http://www.w3.org/XML/1998/namespace",
ohair@286:          *      "urn:oasis:names:specification:docbook:dtd:xml:4.1.2", or "".
ohair@286:          */
ohair@286:         String getNamespaceURI();
ohair@286:     }
ohair@286: }