001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.internal;
014
015import java.util.*;
016
017import org.apache.juneau.*;
018import org.apache.juneau.collections.*;
019
020/**
021 * Represents a wrapped {@link Map} where entries in the map can be removed without affecting the underlying map.
022 *
023 * @param <T> The class type of the wrapped bean.
024 */
025@SuppressWarnings("rawtypes")
026public class DelegateMap<T extends Map> extends OMap implements Delegate<T> {
027   private static final long serialVersionUID = 1L;
028
029   private transient ClassMeta<T> classMeta;
030
031   /**
032    * Constructor.
033    *
034    * @param m The metadata object that created this delegate object.
035    * @param session The current bean session.
036    */
037   public DelegateMap(T m, BeanSession session) {
038      this.classMeta = session.getClassMetaForObject(m);
039      for (Map.Entry e : (Set<Map.Entry>)m.entrySet())
040         put(StringUtils.stringify(e.getKey()), e.getValue());
041   }
042
043   @Override /* Delegate */
044   public ClassMeta<T> getClassMeta() {
045      return classMeta;
046   }
047
048   /**
049    * Remove all but the specified keys from this map.
050    *
051    * <p>
052    * This does not affect the underlying map.
053    *
054    * @param keys The remaining keys in the map (in the specified order).
055    * @return This object (for method chaining).
056    */
057   public DelegateMap<T> filterKeys(List<String> keys) {
058      OMap m2 = new OMap();
059      for (String k : keys)
060         if (containsKey(k))
061            m2.put(k, get(k));
062      this.clear();
063      this.putAll(m2);
064      return this;
065   }
066}