Interface HttpEncoding

  • All Known Implementing Classes:
    GZipEncoding

    public interface HttpEncoding
    HTTP content encoding.

    Implementations don't need to be thread-safe.

    Since:
    1.14
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void encode​(StreamingContent content, java.io.OutputStream out)
      Encodes the streaming content into the output stream.
      java.lang.String getName()
      Returns the content encoding name (for example "gzip") or null for none.
    • Method Detail

      • getName

        java.lang.String getName()
        Returns the content encoding name (for example "gzip") or null for none.
      • encode

        void encode​(StreamingContent content,
                    java.io.OutputStream out)
             throws java.io.IOException
        Encodes the streaming content into the output stream.

        Implementations must not close the output stream, and instead should flush the output stream. Some callers may assume that the output stream has not been closed, and will fail to work if it has been closed.

        Parameters:
        content - streaming content
        out - output stream
        Throws:
        java.io.IOException