src/org/xml/sax/XMLReader.java

Print this page
rev 602 : 8047723: @since tag cleanup in jaxp
Reviewed-by:


  58  * <p>All SAX interfaces are assumed to be synchronous: the
  59  * {@link #parse parse} methods must not return until parsing
  60  * is complete, and readers must wait for an event-handler callback
  61  * to return before reporting the next event.</p>
  62  *
  63  * <p>This interface replaces the (now deprecated) SAX 1.0 {@link
  64  * org.xml.sax.Parser Parser} interface.  The XMLReader interface
  65  * contains two important enhancements over the old Parser
  66  * interface (as well as some minor ones):</p>
  67  *
  68  * <ol>
  69  * <li>it adds a standard way to query and set features and
  70  *  properties; and</li>
  71  * <li>it adds Namespace support, which is required for many
  72  *  higher-level XML standards.</li>
  73  * </ol>
  74  *
  75  * <p>There are adapters available to convert a SAX1 Parser to
  76  * a SAX2 XMLReader and vice-versa.</p>
  77  *
  78  * @since SAX 2.0
  79  * @author David Megginson
  80  * @see org.xml.sax.XMLFilter
  81  * @see org.xml.sax.helpers.ParserAdapter
  82  * @see org.xml.sax.helpers.XMLReaderAdapter
  83  */
  84 public interface XMLReader
  85 {
  86 
  87 
  88     ////////////////////////////////////////////////////////////////////
  89     // Configuration.
  90     ////////////////////////////////////////////////////////////////////
  91 
  92 
  93     /**
  94      * Look up the value of a feature flag.
  95      *
  96      * <p>The feature name is any fully-qualified URI.  It is
  97      * possible for an XMLReader to recognize a feature name but
  98      * temporarily be unable to return its value.




  58  * <p>All SAX interfaces are assumed to be synchronous: the
  59  * {@link #parse parse} methods must not return until parsing
  60  * is complete, and readers must wait for an event-handler callback
  61  * to return before reporting the next event.</p>
  62  *
  63  * <p>This interface replaces the (now deprecated) SAX 1.0 {@link
  64  * org.xml.sax.Parser Parser} interface.  The XMLReader interface
  65  * contains two important enhancements over the old Parser
  66  * interface (as well as some minor ones):</p>
  67  *
  68  * <ol>
  69  * <li>it adds a standard way to query and set features and
  70  *  properties; and</li>
  71  * <li>it adds Namespace support, which is required for many
  72  *  higher-level XML standards.</li>
  73  * </ol>
  74  *
  75  * <p>There are adapters available to convert a SAX1 Parser to
  76  * a SAX2 XMLReader and vice-versa.</p>
  77  *
  78  * @since 1.4, SAX 2.0
  79  * @author David Megginson
  80  * @see org.xml.sax.XMLFilter
  81  * @see org.xml.sax.helpers.ParserAdapter
  82  * @see org.xml.sax.helpers.XMLReaderAdapter
  83  */
  84 public interface XMLReader
  85 {
  86 
  87 
  88     ////////////////////////////////////////////////////////////////////
  89     // Configuration.
  90     ////////////////////////////////////////////////////////////////////
  91 
  92 
  93     /**
  94      * Look up the value of a feature flag.
  95      *
  96      * <p>The feature name is any fully-qualified URI.  It is
  97      * possible for an XMLReader to recognize a feature name but
  98      * temporarily be unable to return its value.