Entity.java revision 286
0N/A/*
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
0N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
0N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
0N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
0N/A * or visit www.oracle.com if you need additional information or have any
0N/A * questions.
0N/A */
0N/A
0N/A/*
0N/A * This file is available under and governed by the GNU General Public
0N/A * License version 2 only, as published by the Free Software Foundation.
0N/A * However, the following notice accompanied the original version of this
0N/A * file and, per its terms, should not be removed:
0N/A *
0N/A * Copyright (c) 2004 World Wide Web Consortium,
435N/A *
0N/A * (Massachusetts Institute of Technology, European Research Consortium for
0N/A * Informatics and Mathematics, Keio University). All Rights Reserved. This
0N/A * work is distributed under the W3C(r) Software License [1] in the hope that
0N/A * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
0N/A * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
0N/A *
0N/A * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
0N/A */
0N/A
0N/Apackage org.w3c.dom;
0N/A
0N/A/**
0N/A * This interface represents a known entity, either parsed or unparsed, in an
0N/A * XML document. Note that this models the entity itself <em>not</em> the entity declaration.
0N/A * <p>The <code>nodeName</code> attribute that is inherited from
0N/A * <code>Node</code> contains the name of the entity.
0N/A * <p>An XML processor may choose to completely expand entities before the
0N/A * structure model is passed to the DOM; in this case there will be no
0N/A * <code>EntityReference</code> nodes in the document tree.
0N/A * <p>XML does not mandate that a non-validating XML processor read and
0N/A * process entity declarations made in the external subset or declared in
0N/A * parameter entities. This means that parsed entities declared in the
0N/A * external subset need not be expanded by some classes of applications, and
0N/A * 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'>
0N/A * replacement text</a> is available, the corresponding <code>Entity</code> node's child list
0N/A * represents the structure of that replacement value. Otherwise, the child
0N/A * list is empty.
0N/A * <p>DOM Level 3 does not support editing <code>Entity</code> nodes; if a
0N/A * user wants to make changes to the contents of an <code>Entity</code>,
0N/A * every related <code>EntityReference</code> node has to be replaced in the
0N/A * structure model by a clone of the <code>Entity</code>'s contents, and
0N/A * then the desired changes must be made to each of those clones instead.
0N/A * <code>Entity</code> nodes and all their descendants are readonly.
0N/A * <p>An <code>Entity</code> node does not have any parent.
0N/A * <p ><b>Note:</b> If the entity contains an unbound namespace prefix, the
0N/A * <code>namespaceURI</code> of the corresponding node in the
0N/A * <code>Entity</code> node subtree is <code>null</code>. The same is true
0N/A * for <code>EntityReference</code> nodes that refer to this entity, when
0N/A * they are created using the <code>createEntityReference</code> method of
0N/A * the <code>Document</code> interface.
0N/A * <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>.
0N/A */
0N/Apublic interface Entity extends Node {
0N/A /**
0N/A * The public identifier associated with the entity if specified, and
0N/A * <code>null</code> otherwise.
0N/A */
0N/A public String getPublicId();
0N/A
0N/A /**
0N/A * The system identifier associated with the entity if specified, and
0N/A * <code>null</code> otherwise. This may be an absolute URI or not.
0N/A */
0N/A public String getSystemId();
0N/A
0N/A /**
0N/A * For unparsed entities, the name of the notation for the entity. For
0N/A * parsed entities, this is <code>null</code>.
0N/A */
0N/A public String getNotationName();
0N/A
0N/A /**
0N/A * An attribute specifying the encoding used for this entity at the time
0N/A * of parsing, when it is an external parsed entity. This is
0N/A * <code>null</code> if it an entity from the internal subset or if it
0N/A * is not known.
0N/A * @since DOM Level 3
0N/A */
0N/A public String getInputEncoding();
0N/A
0N/A /**
0N/A * An attribute specifying, as part of the text declaration, the encoding
0N/A * of this entity, when it is an external parsed entity. This is
0N/A * <code>null</code> otherwise.
0N/A * @since DOM Level 3
0N/A */
0N/A public String getXmlEncoding();
0N/A
0N/A /**
0N/A * An attribute specifying, as part of the text declaration, the version
0N/A * number of this entity, when it is an external parsed entity. This is
0N/A * <code>null</code> otherwise.
0N/A * @since DOM Level 3
0N/A */
0N/A public String getXmlVersion();
0N/A
0N/A}
0N/A