Package org.apache.tomcat.util.codec

# Interface Encoder

All Known Subinterfaces:
  `BinaryEncoder`

All Known Implementing Classes:
  `Base64`, `BaseNCodec`

@Deprecated public interface Encoder
Deprecated.
This interface is unused and will be removed in Tomcat 9
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.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Object`
  `encode(Object source)`
  Deprecated.
  Encodes an "Object" and returns the encoded content as an Object.

- ## Method Details

  - ### encode

    Object encode(Object source) throws EncoderException
    Deprecated.
    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.