Interface Encoder


  • 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 whic allows a user to pass a generic Object to any Encoder implementation in the codec package.

    Author:
    Apache Directory Project
    • Method Detail

      • encode

        Object encode​(Object object)
               throws EncoderException
        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:
        object - 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.