Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.commons.codec
Interface Encoder

All Known Subinterfaces:
  BinaryEncoder, StringEncoder

All Known Implementing Classes:
  AbstractCaverphone, Base32, Base64, BaseNCodec, BCodec, BeiderMorseEncoder, BinaryCodec, Caverphone, Caverphone1, Caverphone2, ColognePhonetic, DoubleMetaphone, Hex, Metaphone, QCodec, QuotedPrintableCodec, RefinedSoundex, Soundex, URLCodec

    public interface Encoder

Provides the highest level of abstraction for Encoders. This is the sister interface of `Decoder`. Every implementation of Encoder provides this common generic interface which allows a user to pass a generic Object to any Encoder implementation in the codec package.

Version:
  $Id: Encoder.java 1170351 2011-09-13 21:09:09Z ggregory $
Author:
  Apache Software Foundation

Method Summary
`Object` | `encode(Object source)` Encodes an "Object" and returns the encoded content as an Object.

Method Detail

### encode

    Object encode(Object source)
                  throws EncoderException

  Encodes an "Object" and returns the encoded content as an Object. The Objects here may just be `byte[]` or `String`s depending on the implementation used.

  Parameters:
    `source` - An object to encode
  Returns:
    An "encoded" Object
  Throws:
    `EncoderException` - an encoder exception is thrown if the encoder experiences a failure condition during the encoding process.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002-2011 The Apache Software Foundation. All Rights Reserved.