01: package javax.xml.stream.events;
02:
03: /**
04: * An interface for handling Entity events.
05: *
06: * This event reports entities that have not been resolved
07: * and reports their replacement text unprocessed (if
08: * available). This event will be reported if javax.xml.stream.isReplacingEntityReferences
09: * is set to false. If javax.xml.stream.isReplacingEntityReferences is set to true
10: * entity references will be resolved transparently.
11: *
12: * Entities are handled in two possible ways:
13: *
14: * (1) If javax.xml.stream.isReplacingEntityReferences is set to true
15: * all entity references are resolved and reported as markup transparently.
16: * (2) If javax.xml.stream.isReplacingEntityReferences is set to false
17: * Entity references are reported as an EntityReference Event.
18: *
19: * @version 1.0
20: * @author Copyright (c) 2003 by BEA Systems. All Rights Reserved.
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: }
|