io.servicetalk.encoding.api

Class BufferDecoderGroupBuilder

Object

BufferDecoderGroupBuilder

public final class BufferDecoderGroupBuilder
extends Object

Builder for BufferDecoderGroups.

Constructor Summary

Constructors

Constructor and Description
BufferDecoderGroupBuilder() Create a new instance.
BufferDecoderGroupBuilder(int decodersSizeEstimate) Create a new instance.

Method Summary

Modifier and Type	Method and Description
BufferDecoderGroupBuilder	add(BufferDecoder decoder) Add a new BufferDecoder to the BufferDecoderGroup built by this builder.
BufferDecoderGroupBuilder	add(BufferDecoder decoder, boolean advertised) Add a new BufferDecoder to the BufferDecoderGroup built by this builder.
BufferDecoderGroup	build() Build a new BufferDecoderGroup.

Methods inherited from class Object

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

Constructor Detail

BufferDecoderGroupBuilder

public BufferDecoderGroupBuilder()

Create a new instance.

BufferDecoderGroupBuilder

public BufferDecoderGroupBuilder(int decodersSizeEstimate)

Create a new instance.

Parameters:

decodersSizeEstimate - estimate as to how many BufferDecoder will be included in the BufferDecoderGroup built by this builder.

Method Detail

add

public BufferDecoderGroupBuilder add(BufferDecoder decoder)

Add a new BufferDecoder to the BufferDecoderGroup built by this builder.

Parameters:

decoder - The decoder to add.

Returns:

this.

add

public BufferDecoderGroupBuilder add(BufferDecoder decoder,
                                     boolean advertised)

Add a new BufferDecoder to the BufferDecoderGroup built by this builder.

Parameters:

decoder - The decoder to add.

advertised -

• true - the decoder should be included in BufferDecoderGroup.advertisedMessageEncoding()
• false -the decoder is excluded from BufferDecoderGroup.advertisedMessageEncoding() and therefore won't be included in Accept-Encoding (or equivalent) metadata headers. In this case the peer won't be explicitly be told this decoder is supported. Commonly used to discourage usage of identity decoders in favor of other more preferred options, but still support it as a fallback if there are no common decoders.

Returns:

this.

build

public BufferDecoderGroup build()

Build a new BufferDecoderGroup.

Returns:

a new BufferDecoderGroup.