001    // Copyright 2006, 2007, 2008 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    
015    package org.apache.tapestry5.services;
016    
017    import org.apache.tapestry5.Asset;
018    import org.apache.tapestry5.ioc.Resource;
019    
020    /**
021     * Used by {@link AssetSource} to create new {@link Asset}s as needed.
022     *
023     * @see org.apache.tapestry5.services.AssetSource
024     */
025    public interface AssetFactory
026    {
027        /**
028         * Returns the Resource representing the root folder of the domain this factory is responsible for.
029         */
030        Resource getRootResource();
031    
032        /**
033         * Creates an instance of an asset. Starting with 5.1.0.0, it is preferred (but not required) that the factory
034         * return an instance of {@link org.apache.tapestry5.Asset2}.
035         *
036         * @param resource a resource within this factories domain (derived from the {@linkplain #getRootResource() root
037         *                 resource})
038         * @return an Asset for the resource
039         */
040        Asset createAsset(Resource resource);
041    }