org.apache.commons.codec.Encoder Interface Reference

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

Public Member Functions
Object	encode (Object source) throws EncoderException

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 which allows a user to pass a generic Object to any Encoder implementation in the codec package.

Version

$Id$

Definition at line 29 of file Encoder.java.

Member Function Documentation

Object org.apache.commons.codec.Encoder.encode

(

Object

source

)

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

source

An object to encode

Returns

An "encoded" Object

Exceptions

EncoderException

An encoder exception is thrown if the encoder experiences a failure condition during the encoding process.

---

The documentation for this interface was generated from the following file:

• java/client/src/org/apache/commons/codec/Encoder.java