You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by jm...@apache.org on 2001/03/29 02:04:35 UTC

cvs commit: xml-axis/java/src/org/apache/axis/utils LockableHashtable.java

jmsnell     01/03/28 16:04:35

  Added:       java/src/org/apache/axis/utils LockableHashtable.java
  Log:
  WSDD supports the notion of Handler configuration parameters as being
  "lockable".  That is, once the value is set, it cannot be changed.  This class
  extends the standard java.util.Hashtable to support the notion of "lockable items".
  
  "Locked" items cannot be overwritten with put() or deleted with remove()
  
  Revision  Changes    Path
  1.1                  xml-axis/java/src/org/apache/axis/utils/LockableHashtable.java
  
  Index: LockableHashtable.java
  ===================================================================
  /*
   * The Apache Software License, Version 1.1
   *
   *
   * Copyright (c) 1999 The Apache Software Foundation.  All rights 
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer. 
   *
   * 2. 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.
   *
   * 3. The end-user documentation included with the redistribution,
   *    if any, must include the following acknowledgment:  
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowledgment may appear in the software itself,
   *    if and wherever such third-party acknowledgments normally appear.
   *
   * 4. The names "Axis" and "Apache Software Foundation" must
   *    not be used to endorse or promote products derived from this
   *    software without prior written permission. For written 
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache",
   *    nor may "Apache" appear in their name, without prior written
   *    permission of the Apache Software Foundation.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR
   * ITS 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 software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  import java.util.Hashtable;
  import java.util.Vector;
  
  /**
   * This subclass of the java Hashtable allows individual 
   * entries to be "locked" so that their values cannot be
   * overwritten or removed.
   * 
   * Note, only the put() and remove() methods have been
   * overridden.  The clear() method still removes all
   * entries whether they've been locked or not.
   * 
   * @author James Snell (jasnell@us.ibm.com)
   */
  public class LockableHashtable extends Hashtable { 
  
      /**
       * Stores the keys of the locked entries
       */
      Vector lockedEntries = new Vector();
  
      public LockableHashtable() {
          super();
      }
      
      public LockableHashtable(int p1, float p2) {
          super(p1, p2);
      }
      
      public LockableHashtable(java.util.Map p1) {
          super(p1);
      }
      
      public LockableHashtable(int p1) {
          super(p1);
      }
  
      /**
       * New version of the put() method that allows for explicitly marking
       * items added to the hashtable as locked.
       */
      public synchronized Object put(Object p1, Object p2, boolean locked) {
          if (this.containsKey(p1) && lockedEntries.contains(p1)) {
              return null;
          }
          if (locked) lockedEntries.add(p1);
          return super.put(p1, p2);
      }
      
      /**
       * Overrides the Hashtable.put() method to mark items as not being locked.
       */
      public synchronized Object put(Object p1, Object p2) {
        return put(p1, p2, false);
      }
  
      /**
       * Checks to see if an item is locked before it is removed. 
       */
      public synchronized Object remove(Object p1) {
          if (lockedEntries.contains(p1)) {
            return null;
          }
          if (lockedEntries.contains(p1)) lockedEntries.remove(p1);
        return super.remove(p1);
      }
  }