org.w3c.dom.Entity Maven / Gradle / Ivy
/*
* Portions Copyright 2000-2008 Sun Microsystems, Inc. All Rights
* Reserved. Use is subject to license terms.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
*
* This program 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.
*
* This program 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 at /legal/license.txt).
*
* 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 Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 or visit www.sun.com if you need additional
* information or have any questions.
*/
/*
* Copyright (c) 2000 World Wide Web Consortium,
* (Massachusetts Institute of Technology, Institut National de
* Recherche en Informatique et en Automatique, Keio University). All
* Rights Reserved. This program is distributed under the W3C's Software
* Intellectual Property License. This program 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 W3C License http://www.w3.org/Consortium/Legal/ for more details.
*
* Copyright (c) 2004 World Wide Web Consortium,
*
* (Massachusetts Institute of Technology, European Research Consortium for
* Informatics and Mathematics, Keio University). All Rights Reserved. This
* work is distributed under the W3C(r) Software License [1] 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.
*
* [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
*/
package org.w3c.dom;
/**
* This interface represents an entity, either parsed or unparsed, in an XML
* document. Note that this models the entity itself not the entity
* declaration.
* The nodeName attribute that is inherited from
* Node contains the name of the entity.
*
An XML processor may choose to completely expand entities before the
* structure model is passed to the DOM; in this case there will be no
* EntityReference nodes in the document tree.
*
Note: If a parser expands entity references, the information
* contained in the corresponding Entity node becomes redundant. In the interest
* of footprint and performance, JSR 280 allows implementations to exclude
* Entity nodes corresponding to expanded entity references from
* the DOM tree if those references have been fully expanded by the parser.
*
XML does not mandate that a non-validating XML processor read and
* process entity declarations made in the external subset or declared in
* external parameter entities. This means that parsed entities declared in
* the external subset need not be expanded by some classes of applications,
* and that the replacement text of the entity may not be available. When
* the
* replacement text is available, the corresponding Entity
* node's child list represents the structure of that replacement value.
* Otherwise, the child list is empty.
*
The DOM Level 2 and DOM Level 3 do not support editing Entity nodes; if a
* user wants to make changes to the contents of an Entity,
* every related EntityReference node has to be replaced in the
* structure model by a clone of the Entity's contents, and
* then the desired changes must be made to each of those clones instead.
* Entity nodes and all their descendants are readonly.
*
An Entity node does not have any parent.
*
Note: If the entity
* contains an unbound namespace prefix, the namespaceURI of
* the corresponding node in the Entity node subtree is
* null. The same is true for EntityReference
* nodes that refer to this entity, when they are created using the
* createEntityReference method of the Document
* interface. The DOM Level 2 does not support any mechanism to resolve
* namespace prefixes.
*
See also the Document Object Model (DOM) Level 2 Core Specification and .
*/
public interface Entity extends Node {
/**
* The public identifier associated with the entity, if specified. If the
* public identifier was not specified, this is null.
* @return The public identifier associated with the entity, or null
*/
public String getPublicId();
/**
* The system identifier associated with the entity, if specified. If the
* system identifier was not specified, this is null.
* @return The system identifier associated with the entity or null
*/
public String getSystemId();
/**
* For unparsed entities, the name of the notation for the entity. For
* parsed entities, this is null.
* @return the name of the notation for the entity or null
*/
public String getNotationName();
}