|
| 1 | +/* ==================================================================== |
| 2 | + * The Apache Software License, Version 1.1 |
| 3 | + * |
| 4 | + * Copyright (c) 2003 The Apache Software Foundation. All rights |
| 5 | + * reserved. |
| 6 | + * |
| 7 | + * Redistribution and use in source and binary forms, with or without |
| 8 | + * modification, are permitted provided that the following conditions |
| 9 | + * are met: |
| 10 | + * |
| 11 | + * 1. Redistributions of source code must retain the above copyright |
| 12 | + * notice, this list of conditions and the following disclaimer. |
| 13 | + * |
| 14 | + * 2. Redistributions in binary form must reproduce the above copyright |
| 15 | + * notice, this list of conditions and the following disclaimer in |
| 16 | + * the documentation and/or other materials provided with the |
| 17 | + * distribution. |
| 18 | + * |
| 19 | + * 3. The end-user documentation included with the redistribution, |
| 20 | + * if any, must include the following acknowledgment: |
| 21 | + * "This product includes software developed by the |
| 22 | + * Apache Software Foundation (http://www.apache.org/)." |
| 23 | + * Alternately, this acknowledgment may appear in the software itself, |
| 24 | + * if and wherever such third-party acknowledgments normally appear. |
| 25 | + * |
| 26 | + * 4. The names "Apache" and "Apache Software Foundation" and |
| 27 | + * "Apache Commons" must not be used to endorse or promote products |
| 28 | + * derived from this software without prior written permission. For |
| 29 | + * written permission, please contact apache@apache.org. |
| 30 | + * |
| 31 | + * 5. Products derived from this software may not be called "Apache", |
| 32 | + * "Apache Commons", nor may "Apache" appear in their name, without |
| 33 | + * prior written permission of the Apache Software Foundation. |
| 34 | + * |
| 35 | + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| 36 | + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| 37 | + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| 38 | + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| 39 | + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 40 | + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 41 | + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| 42 | + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| 43 | + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| 44 | + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| 45 | + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| 46 | + * SUCH DAMAGE. |
| 47 | + * ==================================================================== |
| 48 | + * |
| 49 | + * This software consists of voluntary contributions made by many |
| 50 | + * individuals on behalf of the Apache Software Foundation. For more |
| 51 | + * information on the Apache Software Foundation, please see |
| 52 | + * <http://www.apache.org/>. |
| 53 | + */ |
| 54 | +package org.apache.commons.codec; |
| 55 | + |
| 56 | +/** |
| 57 | + * A StringDecoder is a decoder which expects a String as |
| 58 | + * a method parameter and one that produces a String as the |
| 59 | + * output of the decoding process. |
| 60 | + * |
| 61 | + * @author tobrien@transolutions.net |
| 62 | + * @version $Revision: 1.1 $ |
| 63 | + */ |
| 64 | +public interface StringDecoder extends Decoder { |
| 65 | + |
| 66 | + /** |
| 67 | + * Decode a String and produce a String. |
| 68 | + * |
| 69 | + * @param pString a String to encode |
| 70 | + * |
| 71 | + * @return the encoded String |
| 72 | + * |
| 73 | + * @throws DecoderException thrown if there is |
| 74 | + * an error conidition during the Encoding process. |
| 75 | + */ |
| 76 | + String decode(String pString) throws DecoderException; |
| 77 | +} |
| 78 | + |
0 commit comments