001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    
018    package org.apache.commons.codec;
019    
020    /**
021     * Defines common encoding methods for String encoders.
022     *
023     * @version $Id: StringEncoder.html 889935 2013-12-11 05:05:13Z ggregory $
024     */
025    public interface StringEncoder extends Encoder {
026    
027        /**
028         * Encodes a String and returns a String.
029         *
030         * @param source
031         *            the String to encode
032         * @return the encoded String
033         * @throws EncoderException
034         *             thrown if there is an error condition during the encoding process.
035         */
036        String encode(String source) throws EncoderException;
037    }
038