001// Copyright 2004, 2005 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.tapestry.parse;
016
017import org.apache.hivemind.Resource;
018import org.apache.tapestry.spec.IApplicationSpecification;
019import org.apache.tapestry.spec.IComponentSpecification;
020import org.apache.tapestry.spec.ILibrarySpecification;
021
022/**
023 * Service interface for a wrapper around the class
024 * {@link org.apache.tapestry.parse.SpecificationParser}.
025 * Because the implementation of {@link org.apache.tapestry.parse.SpecificationParser}
026 * is not threadsafe, the implementation of this
027 * service uses the pooled service model.
028 *
029 * <p>
030 * Note: had to use the 'I' prefix, so that {@link org.apache.tapestry.parse.SpecificationParser}
031 * could keep its name. Otherwise, it makes Spindle support really, really ugly.
032 * 
033 * @author Howard Lewis Ship
034 * @since 4.0
035 */
036public interface ISpecificationParser
037{
038    /**
039     * Parses an application specification from the provided Resource.
040     * 
041     * @throws org.apache.hivemind.ApplicationRuntimeException on any error.
042     */
043    public IApplicationSpecification parseApplicationSpecification(Resource resource);
044
045    public IComponentSpecification parseComponentSpecification(Resource resource);
046
047    public ILibrarySpecification parseLibrarySpecification(Resource resource);
048
049    public IComponentSpecification parsePageSpecification(Resource resource);
050}