001 /*
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
003 *
004 * This code is free software; you can redistribute it and/or modify it
005 * under the terms of the GNU General Public License version 2 only, as
006 * published by the Free Software Foundation. Sun designates this
007 * particular file as subject to the "Classpath" exception as provided
008 * by Sun in the LICENSE file that accompanied this code.
009 *
010 * This code is distributed in the hope that it will be useful, but WITHOUT
011 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
012 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
013 * version 2 for more details (a copy is included in the LICENSE file that
014 * accompanied this code).
015 *
016 * You should have received a copy of the GNU General Public License version
017 * 2 along with this work; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
019 *
020 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
021 * CA 95054 USA or visit www.sun.com if you need additional information or
022 * have any questions.
023 */
024
025 /*
026 * This file is available under and governed by the GNU General Public
027 * License version 2 only, as published by the Free Software Foundation.
028 * However, the following notice accompanied the original version of this
029 * file and, per its terms, should not be removed:
030 *
031 * Copyright (c) 2004 World Wide Web Consortium,
032 *
033 * (Massachusetts Institute of Technology, European Research Consortium for
034 * Informatics and Mathematics, Keio University). All Rights Reserved. This
035 * work is distributed under the W3C(r) Software License [1] in the hope that
036 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
037 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
038 *
039 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
040 */
041
042 package org.w3c.dom;
043
044 /**
045 * This interface represents a known entity, either parsed or unparsed, in an
046 * XML document. Note that this models the entity itself <em>not</em> the entity declaration.
047 * <p>The <code>nodeName</code> attribute that is inherited from
048 * <code>Node</code> contains the name of the entity.
049 * <p>An XML processor may choose to completely expand entities before the
050 * structure model is passed to the DOM; in this case there will be no
051 * <code>EntityReference</code> nodes in the document tree.
052 * <p>XML does not mandate that a non-validating XML processor read and
053 * process entity declarations made in the external subset or declared in
054 * parameter entities. This means that parsed entities declared in the
055 * external subset need not be expanded by some classes of applications, and
056 * that the replacement text of the entity may not be available. When the <a href='http://www.w3.org/TR/2004/REC-xml-20040204#intern-replacement'>
057 * replacement text</a> is available, the corresponding <code>Entity</code> node's child list
058 * represents the structure of that replacement value. Otherwise, the child
059 * list is empty.
060 * <p>DOM Level 3 does not support editing <code>Entity</code> nodes; if a
061 * user wants to make changes to the contents of an <code>Entity</code>,
062 * every related <code>EntityReference</code> node has to be replaced in the
063 * structure model by a clone of the <code>Entity</code>'s contents, and
064 * then the desired changes must be made to each of those clones instead.
065 * <code>Entity</code> nodes and all their descendants are readonly.
066 * <p>An <code>Entity</code> node does not have any parent.
067 * <p ><b>Note:</b> If the entity contains an unbound namespace prefix, the
068 * <code>namespaceURI</code> of the corresponding node in the
069 * <code>Entity</code> node subtree is <code>null</code>. The same is true
070 * for <code>EntityReference</code> nodes that refer to this entity, when
071 * they are created using the <code>createEntityReference</code> method of
072 * the <code>Document</code> interface.
073 * <p>See also the <a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407'>Document Object Model (DOM) Level 3 Core Specification</a>.
074 */
075 public interface Entity extends Node {
076 /**
077 * The public identifier associated with the entity if specified, and
078 * <code>null</code> otherwise.
079 */
080 public String getPublicId();
081
082 /**
083 * The system identifier associated with the entity if specified, and
084 * <code>null</code> otherwise. This may be an absolute URI or not.
085 */
086 public String getSystemId();
087
088 /**
089 * For unparsed entities, the name of the notation for the entity. For
090 * parsed entities, this is <code>null</code>.
091 */
092 public String getNotationName();
093
094 /**
095 * An attribute specifying the encoding used for this entity at the time
096 * of parsing, when it is an external parsed entity. This is
097 * <code>null</code> if it an entity from the internal subset or if it
098 * is not known.
099 * @since DOM Level 3
100 */
101 public String getInputEncoding();
102
103 /**
104 * An attribute specifying, as part of the text declaration, the encoding
105 * of this entity, when it is an external parsed entity. This is
106 * <code>null</code> otherwise.
107 * @since DOM Level 3
108 */
109 public String getXmlEncoding();
110
111 /**
112 * An attribute specifying, as part of the text declaration, the version
113 * number of this entity, when it is an external parsed entity. This is
114 * <code>null</code> otherwise.
115 * @since DOM Level 3
116 */
117 public String getXmlVersion();
118
119 }
|