001    // Copyright 2010 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.messages;
016    
017    import java.io.IOException;
018    import java.util.Map;
019    
020    import org.apache.tapestry5.ioc.Messages;
021    import org.apache.tapestry5.ioc.Resource;
022    import org.apache.tapestry5.ioc.util.CaseInsensitiveMap;
023    
024    /**
025     * Used when constructing a component's {@link Messages} object. Responsible for reading the
026     * contents of an individual {@link Resource}.
027     * 
028     * @since 5.2.0
029     */
030    public interface PropertiesFileParser
031    {
032        /**
033         * Read the contents of the file (which is expected to exist) and return it as
034         * a Map of string keys and values (as {@link CaseInsensitiveMap} should be used. The implementation should not
035         * attempt to cache any values (caching occurs at a higher level, as does reload logic).
036         */
037        Map<String, String> parsePropertiesFile(Resource resource) throws IOException;
038    }