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 static org.apache.juneau.common.utils.Utils.*;
020
021/**
022 * Interface for the resolution of vars that consist of a comma-delimited list.
023 *
024 * <h5 class='figure'>Example:</h5>
025 * <p class='bjava'>
026 *    <js>"$X{foo, bar, baz}"</js>
027 * </p>
028 *
029 * <h5 class='section'>See Also:</h5><ul>
030 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/SimpleVariableLanguageBasics">Simple Variable Language Basics</a>
031 * </ul>
032 */
033public abstract class MultipartVar extends SimpleVar {
034
035   /**
036    * Constructor.
037    *
038    * @param name The name of this variable.
039    */
040   public MultipartVar(String name) {
041      super(name);
042   }
043
044   /**
045    * The interface that needs to be implemented for this interface.
046    *
047    * @param session The session object used for a single instance of a string resolution.
048    * @param args The arguments inside the variable.
049    * @return The resolved variable.
050    */
051   public abstract String resolve(VarResolverSession session, String[] args);
052
053   @Override /* Var */
054   public String resolve(VarResolverSession session, String s) {
055      String[] s2 = s.indexOf(',') == -1 ? new String[]{s.trim()} : splita(s);
056      return resolve(session, s2);
057   }
058}