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.svl;
018
019import org.apache.juneau.collections.*;
020
021/**
022 * Subclass of an {@link JsonMap} that automatically resolves any SVL variables in values.
023 *
024 * <p>
025 * Resolves variables in the following values:
026 * <ul>
027 *    <li>Values of type {@link CharSequence}.
028 *    <li>Arrays containing values of type {@link CharSequence}.
029 *    <li>Collections containing values of type {@link CharSequence}.
030 *    <li>Maps containing values of type {@link CharSequence}.
031 * </ul>
032 *
033 * <p>
034 * All other data types are left as-is.
035 *
036 * <h5 class='section'>See Also:</h5><ul>
037 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/SimpleVariableLanguageBasics">Simple Variable Language Basics</a>
038 * </ul>
039 */
040@SuppressWarnings({"serial"})
041public class ResolvingJsonMap extends JsonMap {
042
043   private final VarResolverSession varResolver;
044
045   /**
046    * Constructor.
047    *
048    * @param varResolver The var resolver session to use for resolving SVL variables.
049    */
050   public ResolvingJsonMap(VarResolverSession varResolver) {
051      this.varResolver = varResolver;
052   }
053
054   @Override /* Map */
055   public Object get(Object key) {
056      return varResolver.resolve(super.get(key));
057   }
058}