internal.org.jvnet.staxex.NamespaceContextEx Maven / Gradle / Ivy
Show all versions of webservices-osgi Show documentation
/*
* Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package internal.org.jvnet.staxex;
import javax.xml.namespace.NamespaceContext;
import java.util.Iterator;
/**
* Extended {@link NamespaceContext}.
*
* @author Kohsuke Kawaguchi
* @author Paul Sandoz
*/
public interface NamespaceContextEx extends NamespaceContext, Iterable {
/**
* Iterates all the in-scope namespace bindings.
*
*
* This method enumerates all the active in-scope namespace bindings.
* This does not include implicit bindings, such as
* {@code "xml"->"http://www.w3.org/XML/1998/namespace"}
* or {@code ""->""} (the implicit default namespace URI.)
*
*
* The returned iterator may not include the same prefix more than once.
* For example, the returned iterator may only contain {@code f=ns2}
* if the document is as follows and this method is used at the bar element.
*
*
{@code
*
*
* ...
* }
*
*
* The iteration may be done in no particular order.
*
* @return
* may return an empty iterator, but never null.
*/
Iterator iterator();
/**
* Prefix to namespace URI binding.
*/
interface Binding {
/**
* Gets the prefix.
*
*
* The default namespace URI is represented by using an
* empty string "", not null.
*
* @return
* never null. String like "foo", "ns12", or "".
*/
String getPrefix();
/**
* Gets the namespace URI.
*
*
* The empty namespace URI is represented by using
* an empty string "", not null.
*
* @return
* never null. String like "http://www.w3.org/XML/1998/namespace",
* "urn:oasis:names:specification:docbook:dtd:xml:4.1.2", or "".
*/
String getNamespaceURI();
}
}