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.svl.vars;
014
015import org.apache.juneau.svl.*;
016
017/**
018 * Lower-case variable resolver.
019 *
020 * <p>
021 * The format for this var is <js>"$LC{stringValue}"</js>.
022 *
023 * <p>
024 * This variable simply converts to value to lower-case.
025 *
026 * <p>
027 * Since this is a {@link SimpleVar}, any variables contained in the result will be recursively resolved.
028 * Likewise, if the arguments contain any variables, those will be resolved before they are passed to this var.
029 *
030 * <h5 class='section'>See Also:</h5><ul>
031 *    <li class='link'><a class="doclink" href="../../../../../index.html#jm.SimpleVariableLanguage">Simple Variable Language</a>
032 * </ul>
033 */
034public class LowerCaseVar extends SimpleVar {
035
036   /** The name of this variable. */
037   public static final String NAME = "LC";
038
039   /**
040    * Constructor.
041    */
042   public LowerCaseVar() {
043      super(NAME);
044   }
045
046   @Override /* Parameter */
047   public String resolve(VarResolverSession session, String key) {
048      return key.toLowerCase();
049   }
050}