org.apache.commons.codec

Interface Encoder

public interface Encoder

Provides the highest level of abstraction for Encoders. This is the sister interface of {@link 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.

Version: $Id: Encoder.java 130304 2004-02-29 04:08:31Z tobrien $

Author: Apache Software Foundation

Method Summary
Objectencode(Object pObject)
Encodes an "Object" and returns the encoded content as an Object.

Method Detail

encode

public Object encode(Object pObject)
Encodes an "Object" and returns the encoded content as an Object. The Objects here may just be byte[] or Strings depending on the implementation used.

Parameters: pObject An object ot encode

Returns: An "encoded" Object

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

commons-codec version 1.3 - Copyright © 2002-2004 - Apache Software Foundation