Source for org.jfree.report.i18n.ResourceBundleFactory

   1: /**
   2:  * ========================================
   3:  * JFreeReport : a free Java report library
   4:  * ========================================
   5:  *
   6:  * Project Info:  http://reporting.pentaho.org/
   7:  *
   8:  * (C) Copyright 2000-2007, by Object Refinery Limited, Pentaho Corporation and Contributors.
   9:  *
  10:  * This library is free software; you can redistribute it and/or modify it under the terms
  11:  * of the GNU Lesser General Public License as published by the Free Software Foundation;
  12:  * either version 2.1 of the License, or (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
  15:  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  16:  * See the GNU Lesser General Public License for more details.
  17:  *
  18:  * You should have received a copy of the GNU Lesser General Public License along with this
  19:  * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20:  * Boston, MA 02111-1307, USA.
  21:  *
  22:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
  23:  * in the United States and other countries.]
  24:  *
  25:  * ------------
  26:  * $Id: ResourceBundleFactory.java 2725 2007-04-01 18:49:29Z taqua $
  27:  * ------------
  28:  * (C) Copyright 2000-2005, by Object Refinery Limited.
  29:  * (C) Copyright 2005-2007, by Pentaho Corporation.
  30:  */
  31: package org.jfree.report.i18n;
  32: 
  33: import java.io.Serializable;
  34: import java.util.Locale;
  35: import java.util.ResourceBundle;
  36: 
  37: /**
  38:  * A resource bundle factory defines the locale for a report and is used to create
  39:  * resourcebundles.
  40:  *
  41:  * @author Thomas Morgner
  42:  */
  43: public interface ResourceBundleFactory extends Serializable
  44: {
  45:   public static final String DEFAULT_RESOURCE_BUNDLE_CONFIG_KEY =
  46:           "org.jfree.report.ResourceBundle";
  47:   /**
  48:    * Creates a resource bundle for the given key. How that key is interpreted depends on
  49:    * the used concrete implementation of this interface.
  50:    *
  51:    * @param key the key that identifies the resource bundle
  52:    * @return the created resource bundle
  53:    *
  54:    * @throws java.util.MissingResourceException
  55:    *          if no resource bundle for the specified base name can be found
  56:    */
  57:   public ResourceBundle getResourceBundle (final Locale locale, final String key);
  58: }