2009/05/20 - Apache Shale has been retired.

   /*
    * Licensed to the Apache Software Foundation (ASF) under one or more
    * contributor license agreements.  See the NOTICE file distributed with
    * this work for additional information regarding copyright ownership.
    * The ASF licenses this file to you under the Apache License, Version 2.0
    * (the "License"); you may not use this file except in compliance with
    * the License.  You may obtain a copy of the License at
    *
    *      http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package org.apache.shale.test.mock;
  
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.Enumeration;
  import java.util.HashSet;
  import java.util.Iterator;
  import java.util.List;
  import java.util.Map;
  import java.util.Set;
  
  import javax.servlet.http.HttpSession;
  
  
  /***
   * <p>Mock impementation of <code>Map</code> for the session scope
   * attributes managed by {@link MockExternalContext}.</p>
   *
   * $Id$
   */
  
  class MockSessionMap implements Map {
  
  
      // ------------------------------------------------------------ Constructors
  
  
      /***
       * <p>Construct an instance exposing the attributes of the specified
       * session.</p>
       *
       * @param session Session whose attributes are to be exposed
       *  as a Map
       */
      public MockSessionMap(HttpSession session) {
  
          this.session = session;
  
      }
  
  
      // ----------------------------------------------------- Mock Object Methods
  
  
      // ------------------------------------------------------ Instance Variables
  
  
      /***
       * <p>The session whose attributes we are exposing as a Map.</p>
       */
      private HttpSession session = null;
  
  
      // ------------------------------------------------------------- Map Methods
  
  
      /*** {@inheritDoc} */
      public void clear() {
  
          Iterator keys = keySet().iterator();
          while (keys.hasNext()) {
              session.removeAttribute((String) keys.next());
          }
  
      }
  
  
      /*** {@inheritDoc} */
      public boolean containsKey(Object key) {
  
          return session.getAttribute(key(key)) != null;
  
      }
  
  
      /*** {@inheritDoc} */
      public boolean containsValue(Object value) {
  
          if (value == null) {
              return false;
          }
          Enumeration keys = session.getAttributeNames();
         while (keys.hasMoreElements()) {
             Object next = session.getAttribute((String) keys.nextElement());
             if (next == value) {
                 return true;
             }
         }
         return false;
 
     }
 
 
     /*** {@inheritDoc} */
     public Set entrySet() {
 
         Set set = new HashSet();
         Enumeration keys = session.getAttributeNames();
         while (keys.hasMoreElements()) {
             set.add(session.getAttribute((String) keys.nextElement()));
         }
         return set;
 
     }
 
 
     /*** {@inheritDoc} */
     public boolean equals(Object o) {
 
         return session.equals(o);
 
     }
 
 
     /*** {@inheritDoc} */
     public Object get(Object key) {
 
         return session.getAttribute(key(key));
 
     }
 
 
     /*** {@inheritDoc} */
     public int hashCode() {
 
         return session.hashCode();
 
     }
 
 
     /*** {@inheritDoc} */
     public boolean isEmpty() {
 
         return size() < 1;
 
     }
 
 
     /*** {@inheritDoc} */
     public Set keySet() {
 
         Set set = new HashSet();
         Enumeration keys = session.getAttributeNames();
         while (keys.hasMoreElements()) {
             set.add(keys.nextElement());
         }
         return set;
 
     }
 
 
     /*** {@inheritDoc} */
     public Object put(Object key, Object value) {
 
         if (value == null) {
             return remove(key);
         }
         String skey = key(key);
         Object previous = session.getAttribute(skey);
         session.setAttribute(skey, value);
         return previous;
 
     }
 
 
     /*** {@inheritDoc} */
     public void putAll(Map map) {
 
         Iterator keys = map.keySet().iterator();
         while (keys.hasNext()) {
             String key = (String) keys.next();
             session.setAttribute(key, map.get(key));
         }
 
     }
 
 
     /*** {@inheritDoc} */
     public Object remove(Object key) {
 
         String skey = key(key);
         Object previous = session.getAttribute(skey);
         session.removeAttribute(skey);
         return previous;
 
     }
 
 
     /*** {@inheritDoc} */
     public int size() {
 
         int n = 0;
         Enumeration keys = session.getAttributeNames();
         while (keys.hasMoreElements()) {
             keys.nextElement();
             n++;
         }
         return n;
 
     }
 
 
     /*** {@inheritDoc} */
     public Collection values() {
 
         List list = new ArrayList();
         Enumeration keys = session.getAttributeNames();
         while (keys.hasMoreElements()) {
             list.add(session.getAttribute((String) keys.nextElement()));
         }
         return (list);
 
     }
 
 
     // --------------------------------------------------------- Private Methods
 
 
     /***
      * <p>Return the specified key, after converting it to a String.</p>
      *
      * @param key Key to be converted
      */
     private String key(Object key) {
 
         if (key == null) {
             throw new IllegalArgumentException();
         } else if (key instanceof String) {
             return ((String) key);
         } else {
             return (key.toString());
         }
 
     }
 
 
 }