Home | History | Annotate | Download | only in codec
      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  * <p>Provides the highest level of abstraction for Encoders.
     21  * This is the sister interface of {@link Decoder}.  Every implementation of
     22  * Encoder provides this common generic interface whic allows a user to pass a
     23  * generic Object to any Encoder implementation in the codec package.</p>
     24  *
     25  * @author Apache Software Foundation
     26  * @version $Id: Encoder.java,v 1.10 2004/02/29 04:08:31 tobrien Exp $
     27  *
     28  * @deprecated Please use {@link java.net.URL#openConnection} instead.
     29  *     Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a>
     30  *     for further details.
     31  */
     32 @Deprecated
     33 public interface Encoder {
     34 
     35     /**
     36      * Encodes an "Object" and returns the encoded content
     37      * as an Object.  The Objects here may just be <code>byte[]</code>
     38      * or <code>String</code>s depending on the implementation used.
     39      *
     40      * @param pObject An object ot encode
     41      *
     42      * @return An "encoded" Object
     43      *
     44      * @throws EncoderException an encoder exception is
     45      *  thrown if the encoder experiences a failure
     46      *  condition during the encoding process.
     47      */
     48     Object encode(Object pObject) throws EncoderException;
     49 }
     50 
     51