View Javadoc
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  package javax.xml.transform;
27  
28  /**
29   * <p>An object that implements this interface that can be called by the processor
30   * to turn a URI used in document(), xsl:import, or xsl:include into a Source object.
31   */
32  public interface URIResolver {
33  
34      /**
35       * Called by the processor when it encounters
36       * an xsl:include, xsl:import, or document() function.
37       *
38       * @param href An href attribute, which may be relative or absolute.
39       * @param base The base URI against which the first argument will be made
40       * absolute if the absolute URI is required.
41       *
42       * @return A Source object, or null if the href cannot be resolved,
43       * and the processor should try to resolve the URI itself.
44       *
45       * @throws TransformerException if an error occurs when trying to
46       * resolve the URI.
47       */
48      public Source resolve(String href, String base)
49          throws TransformerException;
50  }