org.apache.commons.codec
Interface Encoder

All Known Subinterfaces:

BinaryEncoder, StringEncoder

All Known Implementing Classes:

Base64, Metaphone, RefinedSoundex, Soundex

public interface Encoder

Encoder is the sister interface of Decoder, it provides the highest level of abstraction for Encoders. All Encoders implement this common generic interface.

Version:

$Revision: 1.1 $ $Date: 2003/04/25 17:50:56 $

Author:

Tim O'Brien

Method Summary

java.lang.Object

encode(java.lang.Object pObject) All encoders allow a library-user to pass an Object and get an Object in return.

Method Detail

encode

public java.lang.Object encode(java.lang.Object pObject)
                        throws EncoderException

All encoders allow a library-user to pass an Object and get an Object in return. This function encodes an "Object" - returning 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

Throws:

EncoderException - an encoder exception is thrown if the encoder experiences a failure condition during the encoding process.