View Javadoc
1   /*
2    * Copyright (c) 1997, 2010, 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 com.sun.xml.internal.xsom.parser;
27  
28  import java.io.IOException;
29  
30  import org.xml.sax.ContentHandler;
31  import org.xml.sax.EntityResolver;
32  import org.xml.sax.ErrorHandler;
33  import org.xml.sax.InputSource;
34  import org.xml.sax.SAXException;
35  
36  /**
37   * Interface that hides the detail of parsing mechanism.
38   *
39   * @author
40   *     Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
41   */
42  public interface XMLParser {
43      /**
44       * Parses the document identified by the given input source
45       * and sends SAX events to the given content handler.
46       *
47       * <p>
48       * This method must be re-entrant.
49       *
50       * @param errorHandler
51       *      Errors found during the parsing must be reported to
52       *      this handler so that XSOM can recognize that something went wrong.
53       *      Always a non-null valid object
54       * @param entityResolver
55       *      Entity resolution should be done through this interface.
56       *      Can be null.
57       *
58       * @exception SAXException
59       *      If ErrorHandler throws a SAXException, this method
60       *      will tunnel it to the caller. All the other errors
61       *      must be reported to the error handler.
62       */
63      void parse( InputSource source, ContentHandler handler,
64          ErrorHandler errorHandler, EntityResolver entityResolver )
65  
66          throws SAXException, IOException;
67  }