001    /**
002     * ========================================
003     * JFreeReport : a free Java report library
004     * ========================================
005     *
006     * Project Info:  http://reporting.pentaho.org/
007     *
008     * (C) Copyright 2000-2007, by Object Refinery Limited, Pentaho Corporation and Contributors.
009     *
010     * This library is free software; you can redistribute it and/or modify it under the terms
011     * of the GNU Lesser General Public License as published by the Free Software Foundation;
012     * either version 2.1 of the License, or (at your option) any later version.
013     *
014     * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
015     * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
016     * See the GNU Lesser General Public License for more details.
017     *
018     * You should have received a copy of the GNU Lesser General Public License along with this
019     * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
020     * Boston, MA 02111-1307, USA.
021     *
022     * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
023     * in the United States and other countries.]
024     *
025     * ------------
026     * $Id: ResourceBundleFactory.java 3048 2007-07-28 18:02:42Z tmorgner $
027     * ------------
028     * (C) Copyright 2000-2005, by Object Refinery Limited.
029     * (C) Copyright 2005-2007, by Pentaho Corporation.
030     */
031    package org.jfree.report.i18n;
032    
033    import java.io.Serializable;
034    import java.util.Locale;
035    import java.util.ResourceBundle;
036    
037    /**
038     * A resource bundle factory defines the locale for a report and is used to create
039     * resourcebundles.
040     *
041     * @author Thomas Morgner
042     */
043    public interface ResourceBundleFactory extends Serializable
044    {
045      public static final String DEFAULT_RESOURCE_BUNDLE_CONFIG_KEY =
046              "org.jfree.report.ResourceBundle";
047      /**
048       * Creates a resource bundle for the given key. How that key is interpreted depends on
049       * the used concrete implementation of this interface.
050       *
051       * @param key the key that identifies the resource bundle
052       * @return the created resource bundle
053       *
054       * @throws java.util.MissingResourceException
055       *          if no resource bundle for the specified base name can be found
056       */
057      public ResourceBundle getResourceBundle (final Locale locale, final String key);
058    }