01 /*
02 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
03 *
04 * This code is free software; you can redistribute it and/or modify it
05 * under the terms of the GNU General Public License version 2 only, as
06 * published by the Free Software Foundation. Sun designates this
07 * particular file as subject to the "Classpath" exception as provided
08 * by Sun in the LICENSE file that accompanied this code.
09 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
22 * have any questions.
23 */
24
25 /*
26 * This file is available under and governed by the GNU General Public
27 * License version 2 only, as published by the Free Software Foundation.
28 * However, the following notice accompanied the original version of this
29 * file and, per its terms, should not be removed:
30 *
31 * Copyright (c) 2002 World Wide Web Consortium,
32 * (Massachusetts Institute of Technology, Institut National de
33 * Recherche en Informatique et en Automatique, Keio University). All
34 * Rights Reserved. This program is distributed under the W3C's Software
35 * Intellectual Property License. This program is distributed in the
36 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
37 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
38 * PURPOSE.
39 * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
40 */
41
42 package org.w3c.dom.xpath;
43
44 import org.w3c.dom.Element;
45 import org.w3c.dom.Node;
46
47 /**
48 * The <code>XPathNamespace</code> interface is returned by
49 * <code>XPathResult</code> interfaces to represent the XPath namespace node
50 * type that DOM lacks. There is no public constructor for this node type.
51 * Attempts to place it into a hierarchy or a NamedNodeMap result in a
52 * <code>DOMException</code> with the code <code>HIERARCHY_REQUEST_ERR</code>
53 * . This node is read only, so methods or setting of attributes that would
54 * mutate the node result in a DOMException with the code
55 * <code>NO_MODIFICATION_ALLOWED_ERR</code>.
56 * <p>The core specification describes attributes of the <code>Node</code>
57 * interface that are different for different node node types but does not
58 * describe <code>XPATH_NAMESPACE_NODE</code>, so here is a description of
59 * those attributes for this node type. All attributes of <code>Node</code>
60 * not described in this section have a <code>null</code> or
61 * <code>false</code> value.
62 * <p><code>ownerDocument</code> matches the <code>ownerDocument</code> of the
63 * <code>ownerElement</code> even if the element is later adopted.
64 * <p><code>prefix</code> is the prefix of the namespace represented by the
65 * node.
66 * <p><code>nodeName</code> is the same as <code>prefix</code>.
67 * <p><code>nodeType</code> is equal to <code>XPATH_NAMESPACE_NODE</code>.
68 * <p><code>namespaceURI</code> is the namespace URI of the namespace
69 * represented by the node.
70 * <p><code>adoptNode</code>, <code>cloneNode</code>, and
71 * <code>importNode</code> fail on this node type by raising a
72 * <code>DOMException</code> with the code <code>NOT_SUPPORTED_ERR</code>.In
73 * future versions of the XPath specification, the definition of a namespace
74 * node may be changed incomatibly, in which case incompatible changes to
75 * field values may be required to implement versions beyond XPath 1.0.
76 * <p>See also the <a href='http://www.w3.org/2002/08/WD-DOM-Level-3-XPath-20020820'>Document Object Model (DOM) Level 3 XPath Specification</a>.
77 */
78 public interface XPathNamespace extends Node {
79 // XPathNodeType
80 /**
81 * The node is a <code>Namespace</code>.
82 */
83 public static final short XPATH_NAMESPACE_NODE = 13;
84
85 /**
86 * The <code>Element</code> on which the namespace was in scope when it
87 * was requested. This does not change on a returned namespace node even
88 * if the document changes such that the namespace goes out of scope on
89 * that element and this node is no longer found there by XPath.
90 */
91 public Element getOwnerElement();
92
93 }
|