org.apache.commons.codec.Decoder Interface Reference

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

Public Member Functions
Object	decode (Object source) throws DecoderException

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.

Version

$Id$

Definition at line 30 of file Decoder.java.

Member Function Documentation

Object org.apache.commons.codec.Decoder.decode

(

Object

source

)

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 ClassCastException occurs this decode method will throw a DecoderException.

Parameters

source

the 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.

---

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

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