alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  
* <td>Namespace URI return value * </tr> * </thead> * <tbody> * <tr> * <td>DEFAULT_NS_PREFIX ("") * <td>default Namespace URI in the current scope or * <code>{@link * javax.xml.XMLConstants#NULL_NS_URI XMLConstants.NULL_NS_URI("")} * </code> * when there is no default Namespace URI in the current scope</td> * </tr> * <tr> * <td>bound prefix * <td>Namespace URI bound to prefix in current scope * </tr> * <tr> * <td>unbound prefix * <td> * <code>{@link * javax.xml.XMLConstants#NULL_NS_URI XMLConstants.NULL_NS_URI("")} * </code> * </td> * </tr> * <tr> * <td>XMLConstants.XML_NS_PREFIX ("xml") * <td>XMLConstants.XML_NS_URI * ("http://www.w3.org/XML/1998/namespace")</td> * </tr> * <tr> * <td>XMLConstants.XMLNS_ATTRIBUTE ("xmlns") * <td>XMLConstants.XMLNS_ATTRIBUTE_NS_URI * ("http://www.w3.org/2000/xmlns/")</td> * </tr> * <tr> * <td>null * <td>IllegalArgumentException is thrown * </tr> * </tbody> * </table> * * @param prefix prefix to look up * * @return Namespace URI bound to prefix in the current scope * * @throws IllegalArgumentException When <code>prefix is * <code>null */ String getNamespaceURI(String prefix); /** * <p>Get prefix bound to Namespace URI in the current scope.

* * <p>To get all prefixes bound to a Namespace URI in the current * scope, use {@link #getPrefixes(String namespaceURI)}.</p> * * <p>When requesting a prefix by Namespace URI, the following * table describes the returned prefix value for all Namespace URI * values:</p> * * <table border="2" rules="all" cellpadding="4"> * <thead> * <tr> * <th align="center" colspan="2"> * <code>getPrefix(namespaceURI) return value for * specified Namespace URIs * </th> * </tr> * <tr> * <th>Namespace URI parameter * <th>prefix value returned * </tr> * </thead> * <tbody> * <tr> * <td><default Namespace URI> * <td>XMLConstants.DEFAULT_NS_PREFIX ("") * </td> * </tr> * <tr> * <td>bound Namespace URI * <td>prefix bound to Namespace URI in the current scope, * if multiple prefixes are bound to the Namespace URI in * the current scope, a single arbitrary prefix, whose * choice is implementation dependent, is returned</td> * </tr> * <tr> * <td>unbound Namespace URI * <td>null * </tr> * <tr> * <td>XMLConstants.XML_NS_URI * ("http://www.w3.org/XML/1998/namespace")</td> * <td>XMLConstants.XML_NS_PREFIX ("xml") * </tr> * <tr> * <td>XMLConstants.XMLNS_ATTRIBUTE_NS_URI * ("http://www.w3.org/2000/xmlns/")</td> * <td>XMLConstants.XMLNS_ATTRIBUTE ("xmlns") * </tr> * <tr> * <td>null * <td>IllegalArgumentException is thrown * </tr> * </tbody> * </table> * * @param namespaceURI URI of Namespace to lookup * * @return prefix bound to Namespace URI in current context * * @throws IllegalArgumentException When <code>namespaceURI is * <code>null */ String getPrefix(String namespaceURI); /** * <p>Get all prefixes bound to a Namespace URI in the current * scope.</p> * * <p>An Iterator over String elements is returned in an arbitrary, * <strong>implementation dependent, order.

* * <p>The Iterator is * <em>not modifiable. e.g. the * <code>remove() method will throw * <code>UnsupportedOperationException.

* * <p>When requesting prefixes by Namespace URI, the following * table describes the returned prefixes value for all Namespace * URI values:</p> * * <table border="2" rules="all" cellpadding="4"> * <thead> * <tr> * <th align="center" colspan="2"> * getPrefixes(namespaceURI)</code> return value for * specified Namespace URIs</th> * </tr> * <tr> * <th>Namespace URI parameter * <th>prefixes value returned * </tr> * </thead> * <tbody> * <tr> * <td>bound Namespace URI, * including the <default Namespace URI></td> * <td> * <code>Iterator over prefixes bound to Namespace URI in * the current scope in an arbitrary, * <strong>implementation dependent, * order * </td> * </tr> * <tr> * <td>unbound Namespace URI * <td>empty Iterator * </tr> * <tr> * <td>XMLConstants.XML_NS_URI * ("http://www.w3.org/XML/1998/namespace")</td> * <td>Iterator with one element set to * <code>XMLConstants.XML_NS_PREFIX ("xml") * </tr> * <tr> * <td>XMLConstants.XMLNS_ATTRIBUTE_NS_URI * ("http://www.w3.org/2000/xmlns/")</td> * <td>Iterator with one element set to * <code>XMLConstants.XMLNS_ATTRIBUTE ("xmlns") * </tr> * <tr> * <td>null * <td>IllegalArgumentException is thrown * </tr> * </tbody> * </table> * * @param namespaceURI URI of Namespace to lookup * * @return <code>Iterator for all prefixes bound to the * Namespace URI in the current scope * * @throws IllegalArgumentException When <code>namespaceURI is * <code>null */ Iterator getPrefixes(String namespaceURI); }

Other Java examples (source code examples)

Here is a short list of links related to this Java NamespaceContext.java source code file:

Java example source code file (NamespaceContext.java)

This example Java source code file (NamespaceContext.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

iterator, namespacecontext, string, util

The NamespaceContext.java Java example source code

/*
 * Copyright (c) 2003, 2005, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.xml.namespace;

import java.util.Iterator;

/**
 * <p>Interface for read only XML Namespace context processing.

 *
 * <p>An XML Namespace has the properties:

 * <ul>
 *   <li>Namespace URI:
 *       Namespace name expressed as a URI to which the prefix is bound</li>
 *   <li>prefix: syntactically, this is the part of the attribute name
 *       following the <code>XMLConstants.XMLNS_ATTRIBUTE
 *       ("xmlns") in the Namespace declaration</li>
 * </ul>
 * <p>example:
 * <code><element xmlns:prefix="http://Namespace-name-URI">

 *
 * <p>All get*(*) methods operate in the current scope
 * for Namespace URI and prefix resolution.</p>
 *
 * <p>Note that a Namespace URI can be bound to
 * <strong>multiple prefixes in the current scope.  This can
 * occur when multiple <code>XMLConstants.XMLNS_ATTRIBUTE
 * ("xmlns") Namespace declarations occur in the same Start-Tag and
 * refer to the same Namespace URI. e.g.<br />
 * <pre>
 * <element xmlns:prefix1="http://Namespace-name-URI"
 *          xmlns:prefix2="http://Namespace-name-URI">
 * </pre>
 * This can also occur when the same Namespace URI is used in multiple
 * <code>XMLConstants.XMLNS_ATTRIBUTE ("xmlns") Namespace
 * declarations in the logical parent element hierarchy.  e.g.<br />
 * <pre>
 * <parent xmlns:prefix1="http://Namespace-name-URI">
 *   <child xmlns:prefix2="http://Namespace-name-URI">
 *     ...
 *   </child>
 * </parent>
 * </pre>

 *
 * <p>A prefix can only be bound to a single
 * Namespace URI in the current scope.</p>
 *
 * @author <a href="mailto:Jeff.Suttor@Sun.com">Jeff Suttor
 * @see javax.xml.XMLConstants
 *   javax.xml.XMLConstants for declarations of common XML values
 * @see <a href="http://www.w3.org/TR/xmlschema-2/#QName">
 *   XML Schema Part2: Datatypes</a>
 * @see <a href="http://www.w3.org/TR/REC-xml-names/#ns-qualnames">
 *   Namespaces in XML</a>
 * @see <a href="http://www.w3.org/XML/xml-names-19990114-errata">
 *   Namespaces in XML Errata</a>
 * @since 1.5
 */

public interface NamespaceContext {

    /**
     * <p>Get Namespace URI bound to a prefix in the current scope.

     *
     * <p>When requesting a Namespace URI by prefix, the following
     * table describes the returned Namespace URI value for all
     * possible prefix values:</p>
     *
     * <table border="2" rules="all" cellpadding="4">
     *   <thead>
     *     <tr>
     *       <td align="center" colspan="2">
     *         <code>getNamespaceURI(prefix)
     *         return value for specified prefixes
     *       </td>
     *     </tr>
     *     <tr>
     *       <td>prefix parameter
... this post is sponsored by my books ...

#1 New Release!
FP Best Seller

 

new blog posts

 

Copyright 1998-2024 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.