io.servicetalk.grpc.api

Class GrpcMessageEncodings

Object

GrpcMessageEncodings

public final class GrpcMessageEncodings
extends Object

Default available encoding implementations. Encoding none() is always supported regardless of the client or server settings. all() is a set that includes all default encodings deflate() and gzip().

Method Summary

Modifier and Type	Method and Description
static Set<GrpcMessageEncoding>	all() Returns a list of all GrpcMessageEncodings included by default.
static GrpcMessageEncoding	deflate() Returns a DEFLATE based GrpcMessageEncoding backed by Inflater.
static GrpcMessageEncoding	encodingFor(Collection<GrpcMessageEncoding> allowedList, String name) Returns a GrpcMessageEncoding that matches the name.
static GrpcMessageEncoding	gzip() Returns a GZIP based GrpcMessageEncoding backed by Inflater.
static GrpcMessageEncoding	none() Returns the default, always supported 'identity' GrpcMessageEncoding.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

none

public static GrpcMessageEncoding none()

Returns the default, always supported 'identity' GrpcMessageEncoding.

Returns:

the default, always supported 'identity' GrpcMessageEncoding

gzip

public static GrpcMessageEncoding gzip()

Returns a GZIP based GrpcMessageEncoding backed by Inflater.

Returns:

a GZIP based GrpcMessageEncoding backed by Inflater

deflate

public static GrpcMessageEncoding deflate()

Returns a DEFLATE based GrpcMessageEncoding backed by Inflater.

Returns:

a DEFLATE based GrpcMessageEncoding backed by Inflater

all

public static Set<GrpcMessageEncoding> all()

Returns a list of all GrpcMessageEncodings included by default.

Returns:

a list of all GrpcMessageEncodings included by default

encodingFor

@Nullable
public static GrpcMessageEncoding encodingFor(Collection<GrpcMessageEncoding> allowedList,
                                                        @Nullable
                                                        String name)

Returns a GrpcMessageEncoding that matches the name. Returns null if name is null or empty. If name is 'identity' this will always result in NONE regardless of its presence in the allowedList.

Parameters:

allowedList - the source list to find a matching encoding in

name - the encoding name used for the matching predicate

Returns:

an encoding from the allowed-list matching the name, otherwise null if name is null or empty