Source for org.jfree.report.modules.preferences.base.NullConfigStorage

   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: NullConfigStorage.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: 
  32: package org.jfree.report.modules.preferences.base;
  33: 
  34: import org.jfree.util.Configuration;
  35: 
  36: /**
  37:  * An empty default implementation. This config storare will not store any values and will
  38:  * provide no read access to stored properties by denying their existence.
  39:  *
  40:  * @author Thomas Morgner
  41:  */
  42: public class NullConfigStorage implements ConfigStorage
  43: {
  44:   /**
  45:    * DefaultConstructor.
  46:    */
  47:   public NullConfigStorage ()
  48:   {
  49:   }
  50: 
  51:   /**
  52:    * This method does nothing.
  53:    *
  54:    * @param configPath this parameter is not used.
  55:    * @param properties this parameter is not used.
  56:    * @see org.jfree.report.modules.misc.configstore.base.ConfigStorage#storeProperties
  57:    *      (java.lang.String, java.util.Properties)
  58:    */
  59:   public void store (final String configPath, final Configuration properties)
  60:   {
  61:   }
  62: 
  63:   /**
  64:    * Loads the properties from the given path, specifying the given properties as
  65:    * default.
  66:    * <p/>
  67:    * This implementation will always throw and ConfigStoreException as the specified
  68:    * resource is not available.
  69:    *
  70:    * @param configPath the configuration path from where to read the properties.
  71:    * @param defaults   the property set that acts as fallback to provide default values.
  72:    * @return the loaded properties
  73:    *
  74:    * @throws ConfigStoreException always throws this exception as the specified resource
  75:    *                              will be not available.
  76:    */
  77:   public Configuration load (final String configPath, final Configuration defaults)
  78:           throws ConfigStoreException
  79:   {
  80:     throw new ConfigStoreException("This configuration path is not available.");
  81:   }
  82: 
  83:   /**
  84:    * Tests, whether some configuration data exists for the given configuration.
  85:    * <p/>
  86:    * This method returns always false and denies the existence of any resource.
  87:    *
  88:    * @param configPath the configuration path to the property storage.
  89:    * @return always false as this implementation does not store anything.
  90:    */
  91:   public boolean isAvailable (final String configPath)
  92:   {
  93:     return false;
  94:   }
  95: }