Encoder (Apache Tomcat 7.0.104 API Documentation)

org.apache.tomcat.util.codec

## Interface Encoder

- All Known Subinterfaces:
    BinaryEncoder
  All Known Implementing Classes:
    Base64, BaseNCodec

      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.

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `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.

Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.