01: package javax.xml.stream.events;
02:
03: /**
04: * An interface for handling Entity Declarations
05: *
06: * This interface is used to record and report unparsed entity declarations.
07: *
08: * @version 1.0
09: * @author Copyright (c) 2003 by BEA Systems. All Rights Reserved.
10: */
11: public interface EntityDeclaration extends XMLEvent {
12:
13: /**
14: * The entity's public identifier, or null if none was given
15: * @return the public ID for this declaration or null
16: */
17: String getPublicId();
18:
19: /**
20: * The entity's system identifier.
21: * @return the system ID for this declaration or null
22: */
23: String getSystemId();
24:
25: /**
26: * The entity's name
27: * @return the name, may not be null
28: */
29: String getName();
30:
31: /**
32: * The name of the associated notation.
33: * @return the notation name
34: */
35: String getNotationName();
36:
37: /**
38: * The replacement text of the entity.
39: * This method will only return non-null
40: * if this is an internal entity.
41: * @return null or the replacment text
42: */
43: String getReplacementText();
44:
45: /**
46: * Get the base URI for this reference
47: * or null if this information is not available
48: * @return the base URI or null
49: */
50: String getBaseURI();
51:
52: }
|