< prev index next >

src/java.xml/share/classes/org/xml/sax/DocumentHandler.java

Print this page


   1 /*
   2  * Copyright (c) 2000, 2005, 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 // SAX document handler.
  27 // http://www.saxproject.org
  28 // No warranty; no copyright -- use this as you will.
  29 // $Id: DocumentHandler.java,v 1.2 2004/11/03 22:44:51 jsuttor Exp $
  30 
  31 package org.xml.sax;
  32 
  33 /**
  34  * Receive notification of general document events.
  35  *
  36  * <blockquote>
  37  * <em>This module, both source code and documentation, is in the
  38  * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em>
  39  * See <a href='http://www.saxproject.org'>http://www.saxproject.org</a>
  40  * for further information.
  41  * </blockquote>
  42  *
  43  * <p>This was the main event-handling interface for SAX1; in
  44  * SAX2, it has been replaced by {@link org.xml.sax.ContentHandler
  45  * ContentHandler}, which provides Namespace support and reporting
  46  * of skipped entities.  This interface is included in SAX2 only
  47  * to support legacy SAX1 applications.</p>
  48  *
  49  * <p>The order of events in this interface is very important, and
  50  * mirrors the order of information in the document itself.  For
  51  * example, all of an element's content (character data, processing
  52  * instructions, and/or subelements) will appear, in order, between
  53  * the startElement event and the corresponding endElement event.</p>
  54  *
  55  * <p>Application writers who do not want to implement the entire
  56  * interface can derive a class from HandlerBase, which implements
  57  * the default functionality; parser writers can instantiate
  58  * HandlerBase to obtain a default handler.  The application can find
  59  * the location of any document event using the Locator interface
  60  * supplied by the Parser through the setDocumentLocator method.</p>
  61  *


   1 /*
   2  * Copyright (c) 2000, 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 package org.xml.sax;
  27 
  28 /**
  29  * Receive notification of general document events.







  30  *
  31  * <p>This was the main event-handling interface for SAX1; in
  32  * SAX2, it has been replaced by {@link org.xml.sax.ContentHandler
  33  * ContentHandler}, which provides Namespace support and reporting
  34  * of skipped entities.  This interface is included in SAX2 only
  35  * to support legacy SAX1 applications.</p>
  36  *
  37  * <p>The order of events in this interface is very important, and
  38  * mirrors the order of information in the document itself.  For
  39  * example, all of an element's content (character data, processing
  40  * instructions, and/or subelements) will appear, in order, between
  41  * the startElement event and the corresponding endElement event.</p>
  42  *
  43  * <p>Application writers who do not want to implement the entire
  44  * interface can derive a class from HandlerBase, which implements
  45  * the default functionality; parser writers can instantiate
  46  * HandlerBase to obtain a default handler.  The application can find
  47  * the location of any document event using the Locator interface
  48  * supplied by the Parser through the setDocumentLocator method.</p>
  49  *


< prev index next >