blob: 46f5404e7a8d3c1635f8fd79f114b5825f206f53 [file] [log] [blame]
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.codec;
/**
* Encodes a String into a String.
*
* @author Apache Software Foundation
* @version $Id: StringEncoder.java,v 1.9 2004/02/29 04:08:31 tobrien Exp $
*/
public interface StringEncoder extends Encoder {
/**
* Encodes a String and returns a String.
*
* @param pString a String to encode
*
* @return the encoded String
*
* @throws EncoderException thrown if there is
* an error conidition during the Encoding process.
*/
String encode(String pString) throws EncoderException;
}