Source for javax.xml.stream.XMLResolver

   1: /* XMLResolver.java -- 
   2:    Copyright (C) 2005,2006  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.xml.stream;
  39: 
  40: /**
  41:  * Interface used to resolve XML external entities during parsing.
  42:  */
  43: public interface XMLResolver
  44: {
  45: 
  46:   /**
  47:    * Returns an input source from which the specified external entity can be
  48:    * read. The following return types are possible:
  49:    * <ol>
  50:    * <li><code>java.io.InputStream</code></li>
  51:    * <li><code>javax.xml.stream.XMLStreamReader</code></li>
  52:    * <li><code>java.xml.stream.XMLEventReader</code></li>
  53:    * </ol>
  54:    * If <code>null</code> is returned, the processor will attempt to resolve
  55:    * the entity itself.
  56:    * @param publicID the public ID of the external entity
  57:    * @param systemID the system ID of the external entity
  58:    * @param baseURI the absolute base URI of the referring entity
  59:    * @param namespace the namespace of the external entity
  60:    */
  61:   Object resolveEntity(String publicID, String systemID,
  62:                        String baseURI, String namespace)
  63:     throws XMLStreamException;
  64: 
  65: }