1 /* 2 * Copyright 2001-2004 The Apache Software Foundation. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package org.apache.commons.codec; 18 19 /** 20 * Encodes a String into a String. 21 * 22 * @author Apache Software Foundation 23 * @version $Id: StringEncoder.java,v 1.9 2004/02/29 04:08:31 tobrien Exp $ 24 */ 25 public interface StringEncoder extends Encoder { 26 27 /** 28 * Encodes a String and returns a String. 29 * 30 * @param pString a String to encode 31 * 32 * @return the encoded String 33 * 34 * @throws EncoderException thrown if there is 35 * an error conidition during the Encoding process. 36 */ 37 String encode(String pString) throws EncoderException; 38 } 39 40
