Interface Encoder

  • All Known Subinterfaces:
    All Known Implementing Classes:
    Base64, BaseNCodec

    public interface Encoder
    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 Detail

      • encode

        java.lang.Object encode​(java.lang.Object source)
                         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.
        source - An object to encode
        An "encoded" Object
        EncoderException - An encoder exception is thrown if the encoder experiences a failure condition during the encoding process.