File Doc Category Size Date Package
Decoder.java API Doc Android 1.5 API 1978 Wed May 06 22:41:10 BST 2009 org.apache.commons.codec

Decoder

public interface Decoder

Provides the highest level of abstraction for Decoders. This is the sister interface of {@link 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.9 2004/02/29 04:08:31 tobrien Exp $

Fields Summary
Constructors Summary
Methods Summary
public java.lang.Object decode(java.lang.Object pObject)
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 {@link java.lang.ClassCastException} occurs this decode method will throw a DecoderException.
param
pObject an object to "decode"
return
a 'decoded" object
throws
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.