Package io.vertx.mutiny.ext.web.codec

Class BodyCodec<T>

java.lang.Object
io.vertx.mutiny.ext.web.codec.BodyCodec<T>
All Implemented Interfaces:
MutinyDelegate
public class BodyCodec<T> extends Object implements MutinyDelegate
A codec for encoding and decoding HTTP bodies.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:
Julien Viet
See Also:
  • BodyCodec

  • Field Details

  • Constructor Details

    • BodyCodec

      public BodyCodec(io.vertx.ext.web.codec.BodyCodec<T> delegate)
      Create a new instance of BodyCodec delegating to the given (non-null) instance of BodyCodec.

    • BodyCodec

      public BodyCodec(io.vertx.ext.web.codec.BodyCodec<T> delegate, TypeArg<T> typeArg_0)

    • BodyCodec

      public BodyCodec(Object delegate, TypeArg<T> typeArg_0)

  • Method Details

    • getDelegate

      public io.vertx.ext.web.codec.BodyCodec<T> getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance

    • string

      public static BodyCodec<String> string()
      Returns:
      the UTF-8 string codec

    • string

      public static BodyCodec<String> string(String encoding)
      A codec for strings using a specific encoding.
      Parameters:
      encoding - the encoding
      Returns:
      the codec

    • buffer

      public static BodyCodec<io.vertx.core.buffer.Buffer> buffer()
      Returns:
      the Buffer codec

    • jsonObject

      public static BodyCodec<io.vertx.core.json.JsonObject> jsonObject()
      Returns:
      the JsonObject codec

    • jsonArray

      public static BodyCodec<io.vertx.core.json.JsonArray> jsonArray()
      Returns:
      the JsonArray codec

    • json

      public static <U> BodyCodec<U> json(Class<U> type)
      Create and return a codec for Java objects encoded using Jackson mapper.
      Returns:
      a codec for mapping POJO to Json

    • none

      public static BodyCodec<Void> none()
      Returns:
      a codec that simply discards the response

    • stream

      public static <T> BodyCodec<T> stream(Function<io.vertx.core.buffer.Buffer,T> decode)
      Create a codec that buffers the entire body and then apply the decode function and returns the result.
      Parameters:
      decode - the decode function
      Returns:
      the created codec

    • pipe

      public static BodyCodec<Void> pipe(WriteStream<io.vertx.core.buffer.Buffer> stream)
      A body codec that pipes the body to a write stream.

      Same as pipe(stream, true).
      Parameters:
      stream - the destination stream
      Returns:
      the body codec for a write stream

    • pipe

      public static BodyCodec<Void> pipe(WriteStream<io.vertx.core.buffer.Buffer> stream, boolean close)
      A body codec that pipes the body to a write stream.
      Parameters:
      stream - the destination stream
      close - whether the destination stream should be closed
      Returns:
      the body codec for a write stream

    • jsonStream

      public static BodyCodec<Void> jsonStream(JsonParser parser)
      A body codec that parse the response as a JSON stream.
      Parameters:
      parser - the non-null JSON parser to emits the JSON object. The parser must be configured for the stream. Not e that you need to keep a reference on the parser to retrieved the JSON events.
      Returns:
      the body codec for a write stream

    • sseStream

      public static BodyCodec<Void> sseStream(Consumer<ReadStream<io.vertx.ext.web.codec.SseEvent>> handler)
      A body codec that parse the response as a Server-SentEvent stream.
      Parameters:
      handler - the non-null handler for the stream of Server-Sent Events.
      Returns:
      the body codec for a write stream

    • newInstance

      public static <T> BodyCodec<T> newInstance(io.vertx.ext.web.codec.BodyCodec<T> delegate)
      Creates a new instance of the BodyCodec.

    • newInstance

      public static <T> BodyCodec<T> newInstance(io.vertx.ext.web.codec.BodyCodec<T> delegate, TypeArg<T> typeArg_0)
      Creates a new instance of the BodyCodec.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object