001    // Copyright 2006 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.internal.services;
016    
017    import org.apache.tapestry5.ioc.Messages;
018    import org.apache.tapestry5.ioc.Resource;
019    
020    /**
021     * Represents a bundle of properties files that can be used to collect properties that are eventually used to form a
022     * {@link Messages}.
023     */
024    public interface MessagesBundle
025    {
026    
027        /**
028         * Returns an object used to identify this particular bundle; this should be a simple immutable value such as a
029         * String.
030         */
031        Object getId();
032    
033        /**
034         * Returns the base resource for this bundle of properties files.
035         */
036        Resource getBaseResource();
037    
038        /**
039         * Returns a parent bundle for this bundle, or null if this bundle has no parent. Parent bundle provide properties
040         * that are overridden by child bundles.
041         */
042        MessagesBundle getParent();
043    }