~ubuntu-branches/ubuntu/maverick/libcommons-digester-java/maverick

« back to all changes in this revision

Viewing changes to src/java/org/apache/commons/digester/substitution/VariableExpander.java

  • Committer: Bazaar Package Importer
  • Author(s): Wolfgang Baer
  • Date: 2006-01-15 16:51:19 UTC
  • mfrom: (0.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060115165119-e7cgj3f6o1fmvlg3
Tags: 1.7-2
* Kaffe compiler transition
* Remove Takashi from uploaders to reflect current maintainership

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/* $Id: VariableExpander.java 155412 2005-02-26 12:58:36Z dirkv $
 
2
 *
 
3
 * Copyright 2003-2004 The Apache Software Foundation.
 
4
 * 
 
5
 * Licensed under the Apache License, Version 2.0 (the "License");
 
6
 * you may not use this file except in compliance with the License.
 
7
 * You may obtain a copy of the License at
 
8
 * 
 
9
 *      http://www.apache.org/licenses/LICENSE-2.0
 
10
 * 
 
11
 * Unless required by applicable law or agreed to in writing, software
 
12
 * distributed under the License is distributed on an "AS IS" BASIS,
 
13
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 
14
 * See the License for the specific language governing permissions and
 
15
 * limitations under the License.
 
16
 */ 
 
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
}
 
37