1 package org.apache.commons.digester3.substitution;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 /**
23 * <p>
24 * An Interface describing a class capable of expanding strings which may contain variable references. The exact syntax
25 * of the "reference", and the mechanism for determining the corresponding value to be used is up to the concrete
26 * implementation.
27 * </p>
28 *
29 * @since 1.6
30 */
31 public interface VariableExpander
32 {
33
34 /**
35 * Return the input string with any variables replaced by their corresponding value. If there are no variables in
36 * the string, then the input parameter is returned unaltered.
37 *
38 * @param param the string containing variables to be replaced.
39 * @return the input string with any variables replaced by their corresponding value.
40 */
41 String expand( String param );
42
43 }