Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ICharacterTranslator |
|
| 1.0;1 |
1 | // Copyright 2004, 2005 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.tapestry.util.text; | |
16 | ||
17 | /** | |
18 | * An interface for translating a character into a string. | |
19 | * | |
20 | * @author mb | |
21 | * @since 4.0 | |
22 | */ | |
23 | public interface ICharacterTranslator | |
24 | { | |
25 | ||
26 | /** | |
27 | * Translates the provided character into a string. | |
28 | * | |
29 | * @param ch | |
30 | * the character to be translated | |
31 | * @return null if the character is not to be translated, an empty string if | |
32 | * the character is to be ignored, or another string to represent | |
33 | * the character translation | |
34 | */ | |
35 | String translate(char ch); | |
36 | } |