1. /*
  2. * Copyright (c) 2000 World Wide Web Consortium,
  3. * (Massachusetts Institute of Technology, Institut National de
  4. * Recherche en Informatique et en Automatique, Keio University). All
  5. * Rights Reserved. This program is distributed under the W3C's Software
  6. * Intellectual Property License. This program is distributed in the
  7. * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
  8. * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  9. * PURPOSE.
  10. * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
  11. */
  12. package org.w3c.dom;
  13. /**
  14. * <code>EntityReference</code> objects may be inserted into the structure
  15. * model when an entity reference is in the source document, or when the
  16. * user wishes to insert an entity reference. Note that character references
  17. * and references to predefined entities are considered to be expanded by
  18. * the HTML or XML processor so that characters are represented by their
  19. * Unicode equivalent rather than by an entity reference. Moreover, the XML
  20. * processor may completely expand references to entities while building the
  21. * structure model, instead of providing <code>EntityReference</code>
  22. * objects. If it does provide such objects, then for a given
  23. * <code>EntityReference</code> node, it may be that there is no
  24. * <code>Entity</code> node representing the referenced entity. If such an
  25. * <code>Entity</code> exists, then the subtree of the
  26. * <code>EntityReference</code> node is in general a copy of the
  27. * <code>Entity</code> node subtree. However, this may not be true when an
  28. * entity contains an unbound namespace prefix. In such a case, because the
  29. * namespace prefix resolution depends on where the entity reference is, the
  30. * descendants of the <code>EntityReference</code> node may be bound to
  31. * different namespace URIs.
  32. * <p>As for <code>Entity</code> nodes, <code>EntityReference</code> nodes and
  33. * all their descendants are readonly.
  34. * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113'>Document Object Model (DOM) Level 2 Core Specification</a>.
  35. */
  36. public interface EntityReference extends Node {
  37. }