KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > xml > stream > events > StartDocument


1 package javax.xml.stream.events;
2 /**
3  * An interface for the start document event
4  *
5  * @version 1.0
6  * @author Copyright (c) 2003 by BEA Systems. All Rights Reserved.
7  * @since 1.6
8  */
9 public interface StartDocument extends XMLEvent {
10
11   /**
12    * Returns the system ID of the XML data
13    * @return the system ID, defaults to ""
14    */
15   public String JavaDoc getSystemId();
16
17   /**
18    * Returns the encoding style of the XML data
19    * @return the character encoding, defaults to "UTF-8"
20    */
21   public String JavaDoc getCharacterEncodingScheme();
22
23   /**
24    * Returns true if CharacterEncodingScheme was set in
25    * the encoding declaration of the document
26    */
27   public boolean encodingSet();
28
29   /**
30    * Returns if this XML is standalone
31    * @return the standalone state of XML, defaults to "no"
32    */
33   public boolean isStandalone();
34
35   /**
36    * Returns true if the standalone attribute was set in
37    * the encoding declaration of the document.
38    */
39   public boolean standaloneSet();
40
41   /**
42    * Returns the version of XML of this XML stream
43    * @return the version of XML, defaults to "1.0"
44    */
45   public String JavaDoc getVersion();
46 }
47
48
Popular Tags