< prev index next >

src/java.xml/share/classes/javax/xml/stream/events/StartDocument.java

Print this page


   1 /*
   2  * Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  29  *
  30  * @version 1.0
  31  * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
  32  * @since 1.6
  33  */
  34 public interface StartDocument extends XMLEvent {
  35 
  36   /**
  37    * Returns the system ID of the XML data
  38    * @return the system ID, defaults to ""
  39    */
  40   public String getSystemId();
  41 
  42   /**
  43    * Returns the encoding style of the XML data
  44    * @return the character encoding, defaults to "UTF-8"
  45    */
  46   public String getCharacterEncodingScheme();
  47 
  48   /**
  49    * Returns true if CharacterEncodingScheme was set in
  50    * the encoding declaration of the document

  51    */
  52   public boolean encodingSet();
  53 
  54   /**
  55    * Returns if this XML is standalone
  56    * @return the standalone state of XML, defaults to "no"
  57    */
  58   public boolean isStandalone();
  59 
  60   /**
  61    * Returns true if the standalone attribute was set in
  62    * the encoding declaration of the document.

  63    */
  64   public boolean standaloneSet();
  65 
  66   /**
  67    * Returns the version of XML of this XML stream
  68    * @return the version of XML, defaults to "1.0"
  69    */
  70   public String getVersion();
  71 }
   1 /*
   2  * Copyright (c) 2009, 2020, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  29  *
  30  * @version 1.0
  31  * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
  32  * @since 1.6
  33  */
  34 public interface StartDocument extends XMLEvent {
  35 
  36   /**
  37    * Returns the system ID of the XML data
  38    * @return the system ID, defaults to ""
  39    */
  40   public String getSystemId();
  41 
  42   /**
  43    * Returns the encoding style of the XML data
  44    * @return the character encoding, defaults to "UTF-8"
  45    */
  46   public String getCharacterEncodingScheme();
  47 
  48   /**
  49    * Returns true if CharacterEncodingScheme is set in
  50    * the encoding declaration of the document
  51    * @return true if {@code CharacterEncodingScheme} is set, false otherwise
  52    */
  53   public boolean encodingSet();
  54 
  55   /**
  56    * Returns if this XML is standalone
  57    * @return the standalone state of XML, defaults to "no"
  58    */
  59   public boolean isStandalone();
  60 
  61   /**
  62    * Returns true if the standalone attribute is set in
  63    * the encoding declaration of the document.
  64    * @return true if the standalone attribute is set, false otherwise
  65    */
  66   public boolean standaloneSet();
  67 
  68   /**
  69    * Returns the version of XML of this XML stream
  70    * @return the version of XML, defaults to "1.0"
  71    */
  72   public String getVersion();
  73 }
< prev index next >