001    // Copyright 2004, 2005 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry.util.text;
016    
017    /**
018     * An interface for translating a character into a string.
019     * 
020     * @author mb
021     * @since 4.0
022     */
023    public interface ICharacterTranslator
024    {
025    
026        /**
027         * Translates the provided character into a string.
028         * 
029         * @param ch
030         *            the character to be translated
031         * @return null if the character is not to be translated, an empty string if
032         *         the character is to be ignored, or another string to represent
033         *         the character translation
034         */
035        String translate(char ch);
036    }