Decoder Interface Reference

Inheritance diagram for Decoder:

Description

Provides the highest level of abstraction for Decoders. This is the sister interface of com.good.gd.apache.commons.codec.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

Notice

The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.

/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

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

Member Function Documentation

decode()

Object decode

(

Object

pObject

)

throws DecoderException

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 BCodec, QuotedPrintableCodec, URLCodec, QCodec, Base64, Hex, and BinaryCodec.