src/share/jaxws_classes/com/sun/xml/internal/org/jvnet/staxex/NamespaceContextEx.java

Fri, 04 Oct 2013 16:21:34 +0100

author
mkos
date
Fri, 04 Oct 2013 16:21:34 +0100
changeset 408
b0610cd08440
parent 286
f50545b5e2f1
child 637
9c07ef4934dd
permissions
-rw-r--r--

8025054: Update JAX-WS RI integration to 2.2.9-b130926.1035
Reviewed-by: chegar

ohair@286 1 /*
mkos@408 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package com.sun.xml.internal.org.jvnet.staxex;
ohair@286 27
ohair@286 28 import javax.xml.namespace.NamespaceContext;
ohair@286 29 import java.util.Iterator;
ohair@286 30
ohair@286 31 /**
ohair@286 32 * Extended {@link NamespaceContext}.
ohair@286 33 *
ohair@286 34 * @author Kohsuke Kawaguchi
ohair@286 35 * @author Paul Sandoz
ohair@286 36 */
ohair@286 37 public interface NamespaceContextEx extends NamespaceContext, Iterable<NamespaceContextEx.Binding> {
ohair@286 38
ohair@286 39 /**
ohair@286 40 * Iterates all the in-scope namespace bindings.
ohair@286 41 *
ohair@286 42 * <p>
ohair@286 43 * This method enumerates all the active in-scope namespace bindings.
ohair@286 44 * This does not include implicit bindings, such as
ohair@286 45 * <tt>"xml"->"http://www.w3.org/XML/1998/namespace"</tt>
ohair@286 46 * or <tt>""->""</tt> (the implicit default namespace URI.)
ohair@286 47 *
ohair@286 48 * <p>
ohair@286 49 * The returned iterator may not include the same prefix more than once.
ohair@286 50 * For example, the returned iterator may only contain <tt>f=ns2</tt>
ohair@286 51 * if the document is as follows and this method is used at the bar element.
ohair@286 52 *
ohair@286 53 * <pre><xmp>
ohair@286 54 * <foo xmlns:f='ns1'>
ohair@286 55 * <bar xmlns:f='ns2'>
ohair@286 56 * ...
ohair@286 57 * </xmp></pre>
ohair@286 58 *
ohair@286 59 * <p>
ohair@286 60 * The iteration may be done in no particular order.
ohair@286 61 *
ohair@286 62 * @return
ohair@286 63 * may return an empty iterator, but never null.
ohair@286 64 */
ohair@286 65 Iterator<Binding> iterator();
ohair@286 66
ohair@286 67 /**
ohair@286 68 * Prefix to namespace URI binding.
ohair@286 69 */
ohair@286 70 interface Binding {
ohair@286 71 /**
ohair@286 72 * Gets the prefix.
ohair@286 73 *
ohair@286 74 * <p>
ohair@286 75 * The default namespace URI is represented by using an
ohair@286 76 * empty string "", not null.
ohair@286 77 *
ohair@286 78 * @return
ohair@286 79 * never null. String like "foo", "ns12", or "".
ohair@286 80 */
ohair@286 81 String getPrefix();
ohair@286 82
ohair@286 83 /**
ohair@286 84 * Gets the namespace URI.
ohair@286 85 *
ohair@286 86 * <p>
ohair@286 87 * The empty namespace URI is represented by using
ohair@286 88 * an empty string "", not null.
ohair@286 89 *
ohair@286 90 * @return
ohair@286 91 * never null. String like "http://www.w3.org/XML/1998/namespace",
ohair@286 92 * "urn:oasis:names:specification:docbook:dtd:xml:4.1.2", or "".
ohair@286 93 */
ohair@286 94 String getNamespaceURI();
ohair@286 95 }
ohair@286 96 }

mercurial