Main Page | Packages | Class Hierarchy | Class List | Directories | File List | Class Members | Related Pages

org.apache.commons.codec.Encoder Interface Reference

Inheritance diagram for org.apache.commons.codec.Encoder:

org.apache.commons.codec.BinaryEncoder org.apache.commons.codec.StringEncoder org.apache.commons.codec.binary.Base64 org.apache.commons.codec.net.QuotedPrintableCodec org.apache.commons.codec.net.QuotedPrintableCodec List of all members.

Detailed Description

Provides the highest level of abstraction for Encoders. This is the sister interface of Decoder. Every implementation of Encoder provides this common generic interface whic allows a user to pass a generic Object to any Encoder implementation in the codec package.

Author:
Apache Software Foundation
Version:
Id
Encoder.java,v 1.1 2005/07/25 16:24:38 dev Exp

Definition at line 28 of file Encoder.java.

Public Member Functions

Object encode (Object pObject) throws EncoderException
 Encodes an "Object" and returns the encoded content as an Object.


Member Function Documentation

Object org.apache.commons.codec.Encoder.encode Object  pObject  )  throws EncoderException
 

Encodes an "Object" and returns the encoded content as an Object.

The Objects here may just be byte[] or Strings depending on the implementation used.

Parameters:
pObject An object ot encode
Returns:
An "encoded" Object
Exceptions:
EncoderException an encoder exception is thrown if the encoder experiences a failure condition during the encoding process.

Implemented in org.apache.commons.codec.binary.Base64, and org.apache.commons.codec.net.QuotedPrintableCodec.


The documentation for this interface was generated from the following file:
Generated on Wed Dec 14 21:05:37 2005 for OpenMobileIS by  doxygen 1.4.4