public interface

Encoder

org.apache.commons.codec.Encoder
Known Indirect Subclasses

Class Overview

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

Summary

Public Methods
abstract Object encode(Object pObject)
Encodes an "Object" and returns the encoded content as an Object.

Public Methods

public abstract 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.