KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > hivemind > SymbolExpander


1 // Copyright 2007 The Apache Software Foundation
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 package org.apache.hivemind;
16
17 import org.apache.hivemind.Location;
18
19 /**
20  * Manages a list of {@link org.apache.hivemind.SymbolSource} and offers methods to
21  * lookup symbol values and identify symbols in a string and expand them
22  *
23  * @author Howard Lewis Ship
24  */
25 public interface SymbolExpander
26 {
27     /**
28      * Returns the value for the symbol, if this source can provide one.
29      * Iterates all known {@link SymbolSource}s.
30      * Returns null if no source can provide a value.
31      */
32     public String JavaDoc valueForSymbol(String JavaDoc name);
33
34     /**
35      * <p>
36      * Identifies symbols in the text and expands them, using the {@link SymbolSource}. Returns the
37      * modified text. May return text if text does not contain any symbols.
38      *
39      * @param text
40      * the text to scan
41      * @param location
42      * the location to report errors (undefined symbols)
43      */
44     public String JavaDoc expandSymbols(String JavaDoc text, Location location);
45     
46     
47 }
Popular Tags