001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.commons.svl;
018
019import static org.apache.juneau.commons.utils.Shorts.*;
020
021import java.util.*;
022
023/**
024 * A subclass of {@link DefaultingVar} that simply pulls values from a {@link Map}.
025 *
026 * <h5 class='section'>See Also:</h5><ul>
027 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/MarshallSimpleVariableLanguage">Marshall Simple Variable Language</a>
028 * </ul>
029 */
030@SuppressWarnings({
031   "java:S1192", // Duplicated literals (argument/property names) read more clearly inline than as constants
032   "rawtypes" // Raw types necessary for generic type handling
033})
034public abstract class MapVar extends DefaultingVar {
035
036   private final Map m;
037
038   /**
039    * Constructor.
040    *
041    * @param name The name of this variable.  Must not be <jk>null</jk>.
042    * @param m The map to pull values from.  Must not be <jk>null</jk>.
043    */
044   protected MapVar(String name, Map m) {
045      super(name);
046      reqnn("m", m);
047      this.m = m;
048   }
049
050   @Override /* Overridden from Var */
051   public String resolve(VarResolverSession session, String varVal) {
052      return s(m.get(varVal));
053   }
054}