StringCache.java

package org.cdlib.xtf.cache;


/**
 * Copyright (c) 2004, Regents of the University of California
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * - Neither the name of the University of California nor the names of its
 *   contributors may be used to endorse or promote products derived from this
 *   software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * This class caches mappings from a string to a string.
 */
public class StringCache extends SimpleCache 
{
  /**
   * Constructor - establishes the cache.
   *
   * @param cacheName     Name to print out in logAction()
   * @param maxEntries    Max # of entries before old ones are flushed.
   * @param maxTime       Max age (in seconds) of entries before flushed.
   */
  public StringCache(String cacheName, int maxEntries, int maxTime) {
    super(maxEntries, maxTime);
    this.cacheName = cacheName;
  }

  /**
   * Get the value corresponding to the given key
   *
   * @param key   The key to look for
   * @return      Corresponding value, or null if key not found.
   */
  public String get(String key) {
    return (String)super.get(key);
  }

  /** Print out useful debug info */
  protected void logAction(String action, Object key, Object value) 
  {
    //TextServlet.logPrint( 2, cacheName + ": " + action + 
    //                     ". key=" + (String)key );
  }

  /** Name of the cache, printed by logAction() */
  public String cacheName;
} // class StringCache