01: /*
02: * (C) Copyright 2002-2003, Andy Clark. All rights reserved.
03: *
04: * This file is distributed under an Apache style license. Please
05: * refer to the LICENSE file for specific details.
06: */
07:
08: package org.cyberneko.pull.event;
09:
10: import org.cyberneko.pull.XMLEvent;
11:
12: /**
13: * A general entity event. This object denotes the boundaries of general
14: * entity references (e.g. &entity;) occurring in the document instance.
15: * This does <em>not</em> include the five pre-defined XML entities:
16: * &amp;, &lt;, &gt;, &apos;, and &quot;.
17: *
18: * @author Andy Clark
19: *
20: * @version $Id$
21: */
22: public class GeneralEntityEvent extends BoundedEvent {
23:
24: //
25: // Data
26: //
27:
28: /** The name of the general entity. */
29: public String name;
30:
31: /** The namespace of the general entity. */
32: public String namespace;
33:
34: /**
35: * The public identifier. This value will be null if the general entity
36: * was declared as internal <em>or</em> it was declared as external
37: * using a <code>SYSTEM</code> reference.
38: */
39: public String publicId;
40:
41: /**
42: * The base system identifier. This value denotes the expanded system
43: * identifier of the entity where the general entity was declared.
44: * This value will be null if the general entity was declared as
45: * internal.
46: */
47: public String baseSystemId;
48:
49: /**
50: * The literal system identifier used in the general entity declaration.
51: * This value will be null if the general entity was declared as internal.
52: */
53: public String literalSystemId;
54:
55: /**
56: * The expanded system identifier of the general entity declaration.
57: * This value will be null if the general entity was declared as internal.
58: */
59: public String expandedSystemId;
60:
61: /**
62: * The auto-detected encoding of the general entity, if declared as
63: * external.
64: */
65: public String encoding;
66:
67: //
68: // Constructors
69: //
70:
71: /** Default encoding. */
72: public GeneralEntityEvent() {
73: super (XMLEvent.GENERAL_ENTITY);
74: } // <init>()
75:
76: } // class GeneralEntityEvent
|