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