/*

 * Copyright 2000-2005 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package javax.xml.transform;

/**

 * <p>An object that implements this interface that can be called by the processor

 * to turn a URI used in document(), xsl:import, or xsl:include into a Source object.

 */

public interface URIResolver {

    /**

     * Called by the processor when it encounters

     * an xsl:include, xsl:import, or document() function.

     *

     * @param href An href attribute, which may be relative or absolute.

     * @param base The base URI against which the first argument will be made

     * absolute if the absolute URI is required.

     *

     * @return A Source object, or null if the href cannot be resolved,

     * and the processor should try to resolve the URI itself.

     *

     * @throws TransformerException if an error occurs when trying to

     * resolve the URI.

     */

    public Source resolve(String href, String base)

        throws TransformerException;

}