Encoder Interface Reference

Inheritance diagram for Encoder:

Description

Provides the highest level of abstraction for Encoders. This is the sister interface of com.good.gd.apache.commons.codec.Decoder. Every implementation of Encoder provides this common generic interface whic allows a user to pass a generic Object to any Encoder implementation in the codec package.

Author

Apache Software Foundation

Version

Id

Encoder.java,v 1.10 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	encode (Object pObject) throws EncoderException
	Encodes an "Object" and returns the encoded content as an Object. More...

Member Function Documentation

encode()

Object encode

(

Object

pObject

)

throws EncoderException

The Objects here may just be byte[] or Strings depending on the implementation used.

Parameters

pObject

An object ot encode

Returns

An "encoded" Object

Exceptions

EncoderException

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

Implemented in BCodec, BinaryCodec, Base64, Metaphone, QuotedPrintableCodec, URLCodec, QCodec, Soundex, RefinedSoundex, Hex, and DoubleMetaphone.