Source Home >> Java Source 1.6.0 >> javax.xml.transform.URIResolver V 0.09

01/*
02 * The contents of this file are subject to the terms
03 * of the Common Development and Distribution License
04 * (the "License").  You may not use this file except
05 * in compliance with the License.
06 *
07 * You can obtain a copy of the license at
08 * https://jaxp.dev.java.net/CDDLv1.0.html.
09 * See the License for the specific language governing
10 * permissions and limitations under the License.
11 *
12 * When distributing Covered Code, include this CDDL
13 * HEADER in each file and include the License file at
14 * https://jaxp.dev.java.net/CDDLv1.0.html
15 * If applicable add the following below this CDDL HEADER
16 * with the fields enclosed by brackets "[]" replaced with
17 * your own identifying information: Portions Copyright
18 * [year] [name of copyright owner]
19 */
20
21/*
22 * $Id: XMLEntityReader.java,v 1.3 2005/11/03 17:02:21 jeffsuttor Exp $
23 * @(#)URIResolver.java	1.21 05/11/17
24 *
25 * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
26 */
27
28package javax.xml.transform;
29
30/**
31 * <p>An object that implements this interface that can be called by the processor
32 * to turn a URI used in document(), xsl:import, or xsl:include into a Source object.
33 */
34public interface URIResolver {
35
36    /**
37     * Called by the processor when it encounters
38     * an xsl:include, xsl:import, or document() function.
39     *
40     * @param href An href attribute, which may be relative or absolute.
41     * @param base The base URI against which the first argument will be made
42     * absolute if the absolute URI is required.
43     *
44     * @return A Source object, or null if the href cannot be resolved,
45     * and the processor should try to resolve the URI itself.
46     *
47     * @throws TransformerException if an error occurs when trying to
48     * resolve the URI.
49     */
50    public Source resolve(String href, String base)
51        throws TransformerException;
52}