EntityReference


1   package javax.xml.stream.events;
2   /**
3    * An interface for handling Entity events.
4    * 
5    * This event reports entities that have not been resolved
6    * and reports their replacement text unprocessed (if
7    * available).  This event will be reported if javax.xml.stream.isReplacingEntityReferences 
8    * is set to false.  If javax.xml.stream.isReplacingEntityReferences is set to true
9    * entity references will be resolved transparently.
10   *
11   * Entities are handled in two possible ways:
12   *
13   * (1) If javax.xml.stream.isReplacingEntityReferences is set to true
14   * all entity references are resolved and reported as markup transparently.
15   * (2) If javax.xml.stream.isReplacingEntityReferences is set to false
16   * Entity references are reported as an EntityReference Event.
17   *
18   * @version 1.0
19   * @author Copyright (c) 2003 by BEA Systems. All Rights Reserved.
20   * @since 1.6
21   */
22  public interface EntityReference extends XMLEvent {
23  
24    /**
25     * Return the declaration of this entity.
26     */
27    EntityDeclaration getDeclaration();
28  
29    /**
30     * The name of the entity
31     * @return the entity's name, may not be null
32     */
33    String   getName();
34  }
35

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags