1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/jaxws_classes/com/sun/xml/internal/org/jvnet/staxex/NamespaceContextEx.java Tue Mar 06 16:09:35 2012 -0800
1.3 @@ -0,0 +1,96 @@
1.4 +/*
1.5 + * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package com.sun.xml.internal.org.jvnet.staxex;
1.30 +
1.31 +import javax.xml.namespace.NamespaceContext;
1.32 +import java.util.Iterator;
1.33 +
1.34 +/**
1.35 + * Extended {@link NamespaceContext}.
1.36 + *
1.37 + * @author Kohsuke Kawaguchi
1.38 + * @author Paul Sandoz
1.39 + */
1.40 +public interface NamespaceContextEx extends NamespaceContext, Iterable<NamespaceContextEx.Binding> {
1.41 +
1.42 + /**
1.43 + * Iterates all the in-scope namespace bindings.
1.44 + *
1.45 + * <p>
1.46 + * This method enumerates all the active in-scope namespace bindings.
1.47 + * This does not include implicit bindings, such as
1.48 + * <tt>"xml"->"http://www.w3.org/XML/1998/namespace"</tt>
1.49 + * or <tt>""->""</tt> (the implicit default namespace URI.)
1.50 + *
1.51 + * <p>
1.52 + * The returned iterator may not include the same prefix more than once.
1.53 + * For example, the returned iterator may only contain <tt>f=ns2</tt>
1.54 + * if the document is as follows and this method is used at the bar element.
1.55 + *
1.56 + * <pre><xmp>
1.57 + * <foo xmlns:f='ns1'>
1.58 + * <bar xmlns:f='ns2'>
1.59 + * ...
1.60 + * </xmp></pre>
1.61 + *
1.62 + * <p>
1.63 + * The iteration may be done in no particular order.
1.64 + *
1.65 + * @return
1.66 + * may return an empty iterator, but never null.
1.67 + */
1.68 + Iterator<Binding> iterator();
1.69 +
1.70 + /**
1.71 + * Prefix to namespace URI binding.
1.72 + */
1.73 + interface Binding {
1.74 + /**
1.75 + * Gets the prefix.
1.76 + *
1.77 + * <p>
1.78 + * The default namespace URI is represented by using an
1.79 + * empty string "", not null.
1.80 + *
1.81 + * @return
1.82 + * never null. String like "foo", "ns12", or "".
1.83 + */
1.84 + String getPrefix();
1.85 +
1.86 + /**
1.87 + * Gets the namespace URI.
1.88 + *
1.89 + * <p>
1.90 + * The empty namespace URI is represented by using
1.91 + * an empty string "", not null.
1.92 + *
1.93 + * @return
1.94 + * never null. String like "http://www.w3.org/XML/1998/namespace",
1.95 + * "urn:oasis:names:specification:docbook:dtd:xml:4.1.2", or "".
1.96 + */
1.97 + String getNamespaceURI();
1.98 + }
1.99 +}
