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 * Upper-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>
031 * <ul>
032 *    <li class='link'><a class="doclink" href="../../../../../overview-summary.html#juneau-rest-server.SvlVariables">Overview &gt; juneau-rest-server &gt; SVL Variables</a>
033 * </ul>
034 */
035public class LowerCaseVar extends SimpleVar {
036
037   /** The name of this variable. */
038   public static final String NAME = "LC";
039
040   /**
041    * Constructor.
042    */
043   public LowerCaseVar() {
044      super(NAME);
045   }
046
047   @Override /* Parameter */
048   public String resolve(VarResolverSession session, String key) {
049      return key.toLowerCase();
050   }
051}