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

org.apache.commons.codec.Decoder Interface Reference

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

org.apache.commons.codec.BinaryDecoder org.apache.commons.codec.StringDecoder 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 Decoders. This is the sister interface of Encoder. All Decoders implement this common generic interface.

Allows a user to pass a generic Object to any Decoder implementation in the codec package.

One of the two interfaces at the center of the codec package.

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

Definition at line 32 of file Decoder.java.

Public Member Functions

Object decode (Object pObject) throws DecoderException
 Decodes an "encoded" Object and returns a "decoded" Object.


Member Function Documentation

Object org.apache.commons.codec.Decoder.decode Object  pObject  )  throws DecoderException
 

Decodes an "encoded" Object and returns a "decoded" Object.

Note that the implementation of this interface will try to cast the Object parameter to the specific type expected by a particular Decoder implementation. If a java.lang.ClassCastException occurs this decode method will throw a DecoderException.

Parameters:
pObject an object to "decode"
Returns:
a 'decoded" object
Exceptions:
DecoderException a decoder exception can be thrown for any number of reasons. Some good candidates are that the parameter passed to this method is null, a param cannot be cast to the appropriate type for a specific encoder.

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