1 /*

     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     3  *

     4  * This code is free software; you can redistribute it and/or modify it

     5  * under the terms of the GNU General Public License version 2 only, as

     6  * published by the Free Software Foundation.  Oracle designates this

     7  * particular file as subject to the "Classpath" exception as provided

     8  * by Oracle in the LICENSE file that accompanied this code.

     9  *

    10  * This code is distributed in the hope that it will be useful, but WITHOUT

    11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    13  * version 2 for more details (a copy is included in the LICENSE file that

    14  * accompanied this code).

    15  *

    16  * You should have received a copy of the GNU General Public License version

    17  * 2 along with this work; if not, write to the Free Software Foundation,

    18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    19  *

    20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    21  * or visit www.oracle.com if you need additional information or have any

    22  * questions.

    23  */

    24 

    25 /*

    26  * Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.

    27  */

    28 

    29 package javax.xml.stream.events;

    30 /**

    31  * An interface for the start document event

    32  *

    33  * @version 1.0

    34  * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.

    35  * @since 1.6

    36  */

    37 public interface StartDocument extends XMLEvent {

    38 

    39   /**

    40    * Returns the system ID of the XML data

    41    * @return the system ID, defaults to ""

    42    */

    43   public String getSystemId();

    44 

    45   /**

    46    * Returns the encoding style of the XML data

    47    * @return the character encoding, defaults to "UTF-8"

    48    */

    49   public String getCharacterEncodingScheme();

    50 

    51   /**

    52    * Returns true if CharacterEncodingScheme was set in

    53    * the encoding declaration of the document

    54    */

    55   public boolean encodingSet();

    56 

    57   /**

    58    * Returns if this XML is standalone

    59    * @return the standalone state of XML, defaults to "no"

    60    */

    61   public boolean isStandalone();

    62 

    63   /**

    64    * Returns true if the standalone attribute was set in

    65    * the encoding declaration of the document.

    66    */

    67   public boolean standaloneSet();

    68 

    69   /**

    70    * Returns the version of XML of this XML stream

    71    * @return the version of XML, defaults to "1.0"

    72    */

    73   public String getVersion();

    74 }