/*

  * $Id: WebappPropertyResourcesFactory.java 354539 2005-12-06 20:40:16Z niallp $

  * $Revision: 354539 $

  * $Date: 2005-12-06 20:40:16 +0000 (Tue, 06 Dec 2005) $

  *

  * ====================================================================

  *

  *  Copyright 2003-2005 The Apache Software Foundation

  *

  *  Licensed under the Apache License, Version 2.0 (the "License");

  *  you may not use this file except in compliance with the License.

  *  You may obtain a copy of the License at

  *

  *      http://www.apache.org/licenses/LICENSE-2.0

  *

  *  Unless required by applicable law or agreed to in writing, software

  *  distributed under the License is distributed on an "AS IS" BASIS,

  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  *  See the License for the specific language governing permissions and

  *  limitations under the License.

  *

  */

 package org.apache.commons.resources.impl;

 import org.apache.commons.resources.Resources;

 import org.apache.commons.resources.ResourcesException;

 /**

  * <p>Concrete implementation of {@link org.apache.commons.resources.ResourcesFactory} that creates

  * {@link org.apache.commons.resources.Resources} instances that wrap a family (one per Locale) of

  * property files that share a base context-relative path for

  * servlet context resources, and have name suffixes reflecting

  * the Locale for which the file's messages apply.  Resources are

  * looked up in a hierarchy of files in a manner identical to that

  * performed by <code>java.util.ResourceBundle.getBundle()</code>.</p>

  *

  * <p>The configuration variable passed to the <code>createResources()</code>

  * method must be the context-relative base name of the properties file family,

  * and must begin with a slash ('/') character.

  * For example, if the configuration URL is passed as

  * <code>/WEB-INF/resources/MyResources</code>, the resources for the

  * <code>en_US</code> Locale would be stored under context resource

  * <code>/WEB-INF/resources/MyReesources_en_US.properties</code>, and the

  * default resources would be stored in

  * <code>/WEB-INF/resources/MyResources.properties</code>.</p>

  */

 public class WebappPropertyResourcesFactory extends WebappResourcesFactoryBase {

     /**

      * <p>Create and return a new {@link org.apache.commons.resources.Resources} instance with the

      * specified logical name, after calling its <code>init()</code>

      * method and delegating the relevant properties.</p>

      *

      * @param name Logical name of the {@link org.apache.commons.resources.Resources} instance to create

      * @param config Configuration string for this resource (if any)

      * @return The new Resources instance.

      *

      * @exception ResourcesException if a {@link org.apache.commons.resources.Resources} instance

      *  of the specified logical name cannot be created.

      */

     protected Resources createResources(String name, String config) {

         Resources res =

             new WebappPropertyResources(name, config, getServletContext());

         res.setReturnNull(isReturnNull());

         res.init();

         return (res);

     }

 }