Package io.vertx.grpc.common

Interface GrpcMessageDecoder<T>

public interface GrpcMessageDecoder<T>

Field Summary

Fields

Modifier and Type	Field	Description
static GrpcMessageDecoder<Buffer>	IDENTITY
static GrpcMessageDecoder<JsonObject>	JSON_OBJECT	A decoder in JSON format decoding to instances of JsonObject.
static GrpcMessageDecoder<Object>	JSON_VALUE	A decoder in JSON format decoding arbitrary JSON values: JsonObject, JsonArray or string/number/boolean/null

Method Summary

Modifier and Type	Method	Description
boolean	accepts(WireFormat format)	Determines whether the given WireFormat is supported by this decoder.
T	decode(GrpcMessage msg)	Decodes a given gRPC message into an object of type T.
static <T> GrpcMessageDecoder<T>	decoder(com.google.protobuf.MessageOrBuilder messageOrBuilder)	Create a decoder for a given protobuf Parser.
static <T> GrpcMessageDecoder<T>	json(Class<T> clazz)	Create a decoder in JSON format decoding to instances of the clazz using Json.decodeValue(Buffer, Class) (Jackson Databind is required).
static <T> GrpcMessageDecoder<T>	json(Supplier<com.google.protobuf.Message.Builder> builder)	Create a decoder for a given protobuf Parser.
default com.google.protobuf.Descriptors.Descriptor	messageDescriptor()	Returns the protobuf message descriptor if this decoder was created from a protobuf message type, null otherwise.

Field Detail

IDENTITY

static final GrpcMessageDecoder<Buffer> IDENTITY

JSON_OBJECT

static final GrpcMessageDecoder<JsonObject> JSON_OBJECT

A decoder in JSON format decoding to instances of JsonObject.

JSON_VALUE

static final GrpcMessageDecoder<Object> JSON_VALUE

A decoder in JSON format decoding arbitrary JSON values: JsonObject, JsonArray or string/number/boolean/null

Method Detail

decoder

static <T> GrpcMessageDecoder<T> decoder(com.google.protobuf.MessageOrBuilder messageOrBuilder)

Create a decoder for a given protobuf Parser.

Parameters:

messageOrBuilder - the message or builder instance that returns decoded messages of type <T>

Returns:

the message decoder

json

static <T> GrpcMessageDecoder<T> json(Supplier<com.google.protobuf.Message.Builder> builder)

Create a decoder for a given protobuf Parser.

Parameters:

builder - the supplier of a message builder

Returns:

the message decoder

json

static <T> GrpcMessageDecoder<T> json(Class<T> clazz)

Create a decoder in JSON format decoding to instances of the clazz using Json.decodeValue(Buffer, Class) (Jackson Databind is required).

Parameters:

clazz - the java type to decode

Returns:

a decoder that decodes messages to instance of clazz in JSON format.

decode

T decode(GrpcMessage msg)
  throws CodecException

Decodes a given gRPC message into an object of type T.

Parameters:

msg - the gRPC message to decode

Returns:

the decoded message of type T

Throws:

CodecException - if the decoding process fails

accepts

boolean accepts(WireFormat format)

Determines whether the given WireFormat is supported by this decoder.

Parameters:

format - the wire format to check

Returns:

true if the given wire format is accepted, false otherwise

messageDescriptor

@Unstable
default com.google.protobuf.Descriptors.Descriptor messageDescriptor()

Returns the protobuf message descriptor if this decoder was created from a protobuf message type, null otherwise.

Returns:

the protobuf descriptor or null