< prev index next >

src/java.xml/share/classes/org/xml/sax/package-info.java

Print this page


   1 /*
   2  * Copyright (c) 2015, 2017, 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
  23  * questions.
  24  */
  25 
  26 /**
  27  * Provides the core SAX APIs.
  28  * Some SAX1 APIs are deprecated to encourage integration of
  29  * namespace-awareness into designs of new applications
  30  * and into maintenance of existing infrastructure.
  31  *
  32  * <p>
  33  * See <a target='_top' href='http://www.saxproject.org'>http://www.saxproject.org</a>
  34  * for more information about SAX.
  35  *
  36  *
  37  * <h2> SAX2 Standard Feature Flags </h2>
  38  *
  39  * <p>
  40  * One of the essential characteristics of SAX2 is that it added
  41  * feature flags which can be used to examine and perhaps modify
  42  * parser modes, in particular modes such as validation.
  43  * Since features are identified by (absolute) URIs, anyone
  44  * can define such features.
  45  * Currently defined standard feature URIs have the prefix
  46  * <code>http://xml.org/sax/features/</code> before an identifier such as
  47  * <code>validation</code>.  Turn features on or off using
  48  * <em>setFeature</em>.  Those standard identifiers are:
  49  *
  50  *
  51  * <table class="striped">
  52  *     <caption>Standard Features</caption>
  53  *     <thead>
  54  *     <tr>
  55  *      <th scope="col">Feature ID</th>
  56  *      <th scope="col">Access</th>


 313  *          entity inclusions, and the start and end of the DTD
 314  *          (and declaration of document element name).
 315  *          The Object must implement <a href="ext/LexicalHandler.html"
 316  *          ><em>org.xml.sax.ext.LexicalHandler</em></a>.
 317  *         </td>
 318  *     </tr>
 319  *
 320  *     <tr>
 321  *      <th scope="row">xml-string</th>
 322  *      <td> Readable only during a parser callback, this exposes a <b>TBS</b>
 323  *          chunk of characters responsible for the current event.
 324  *         </td>
 325  *     </tr>
 326  *     </tbody>
 327  * </table>
 328  *
 329  * <p>
 330  * All of these standard properties are optional.
 331  * XMLReader implementations are not required to support them.
 332  *



 333  *
 334  * @since 1.4
 335  */
 336 
 337 package org.xml.sax;
   1 /*
   2  * Copyright (c) 2015, 2019, 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
  23  * questions.
  24  */
  25 
  26 /**
  27  * Provides the interfaces for the Simple API for XML (SAX). Supports both
  28  * the SAX1 and SAX2 APIs.


  29  *
  30  * <p>




  31  * <h2> SAX2 Standard Feature Flags </h2>
  32  *
  33  * <p>
  34  * One of the essential characteristics of SAX2 is that it added
  35  * feature flags which can be used to examine and perhaps modify
  36  * parser modes, in particular modes such as validation.
  37  * Since features are identified by (absolute) URIs, anyone
  38  * can define such features.
  39  * Currently defined standard feature URIs have the prefix
  40  * <code>http://xml.org/sax/features/</code> before an identifier such as
  41  * <code>validation</code>.  Turn features on or off using
  42  * <em>setFeature</em>.  Those standard identifiers are:
  43  *
  44  *
  45  * <table class="striped">
  46  *     <caption>Standard Features</caption>
  47  *     <thead>
  48  *     <tr>
  49  *      <th scope="col">Feature ID</th>
  50  *      <th scope="col">Access</th>


 307  *          entity inclusions, and the start and end of the DTD
 308  *          (and declaration of document element name).
 309  *          The Object must implement <a href="ext/LexicalHandler.html"
 310  *          ><em>org.xml.sax.ext.LexicalHandler</em></a>.
 311  *         </td>
 312  *     </tr>
 313  *
 314  *     <tr>
 315  *      <th scope="row">xml-string</th>
 316  *      <td> Readable only during a parser callback, this exposes a <b>TBS</b>
 317  *          chunk of characters responsible for the current event.
 318  *         </td>
 319  *     </tr>
 320  *     </tbody>
 321  * </table>
 322  *
 323  * <p>
 324  * All of these standard properties are optional.
 325  * XMLReader implementations are not required to support them.
 326  *
 327  * @apiNote The SAX API, originally developed at
 328  * <a href="http://www.saxproject.org">the SAX Project</a>, was introduced
 329  * in Java SE 1.4 and continues to be maintained as part of Java SE.
 330  *
 331  * @since 1.4
 332  */
 333 
 334 package org.xml.sax;
< prev index next >