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