    001// Copyright 2011 The Apache Software Foundation
    002//
    003// Licensed under the Apache License, Version 2.0 (the "License");
    004// you may not use this file except in compliance with the License.
    005// You may obtain a copy of the License at
    006//
    007// http://www.apache.org/licenses/LICENSE-2.0
    008//
    009// Unless required by applicable law or agreed to in writing, software
    010// distributed under the License is distributed on an "AS IS" BASIS,
    011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    012// See the License for the specific language governing permissions and
    013// limitations under the License.
    014
    015package org.apache.tapestry5.services.dynamic;
    016
    017import org.apache.tapestry5.commons.Resource;
    018
    019/**
    020 * Parses a dynamic template based on a resource or an input stream.
    021 *
    022 * @since 5.3
    023 */
    024public interface DynamicTemplateParser
    025{
    026    /**
    027     * Given a Resource, parse the XML file into a template. The result is cached (using the Resource itself as the
    028     * key). The DynamicTemplateParser is change aware; it will clear its cache if any underlying Resource
    029     * changes, and will clear the Tapestry page cache as well.
    030     */
    031    DynamicTemplate parseTemplate(Resource resource);
    032}