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