001    // Copyright 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    
015    package org.apache.tapestry.l10n;
016    
017    import java.util.Locale;
018    
019    import org.apache.hivemind.Resource;
020    
021    /**
022     * An interface that defines how to localize a particular resource. A default implementation will
023     * use {@link org.apache.hivemind.Resource#getLocalization(java.util.Locale)}, but this interface
024     * (and associated chain of command configuration point) allows for alternative approaches to
025     * localizing a resource.
026     * 
027     * @author Howard M. Lewis Ship
028     * @since 4.0
029     */
030    public interface ResourceLocalizer
031    {
032        /**
033         * Finds and returns a localization of a root resource for the indicated locale.
034         * 
035         * @param rootResource
036         *            the base resource for which a localization is needed
037         * @param locale
038         *            the locale to find a localization for
039         * @return the localized version of the resource, or null if not found
040         */
041        Resource findLocalization(Resource rootResource, Locale locale);
042    }