Class MessageConfig.Builder<T>

java.lang.Object

io.helidon.messaging.MessageConfig.BuilderBase<T, MessageConfig.Builder<T>, MessageConfig<T>>

io.helidon.messaging.MessageConfig.Builder<T>

Type Parameters:

T - payload type

All Implemented Interfaces:

Prototype.Builder<MessageConfig.Builder<T>, MessageConfig<T>>, Builder<MessageConfig.Builder<T>, Message<T>>, Supplier<Message<T>>

Enclosing interface:

MessageConfig<T>

public static class MessageConfig.Builder<T>
extends MessageConfig.BuilderBase<T, MessageConfig.Builder<T>, MessageConfig<T>>
implements Builder<MessageConfig.Builder<T>, Message<T>>

Fluent API builder for Message.

Method Summary

Modifier and Type	Method	Description
Message<T>	build()	Create an instance from this builder.
MessageConfig<T>	buildPrototype()	Create an instance of the prototype.

Methods inherited from class MessageConfig.BuilderBase

addHeader, addHeader, addHeader, addHeaders, addLocalMetadata, buildPrototype, clearHeaders, entity, entity, from, from, header, header, headers, headers, headers, headers, headers, localMetadata, localMetadata, localMetadata, localMetadata, localMetadata, localMetadata, localMetadata, preBuildPrototype, toString, validatePrototype

Modifier and Type	Method	Description
MessageConfig.Builder<T>	addHeader(MessageHeader header)	Ordered portable headers.
MessageConfig.Builder<T>	addHeader(String name, MessageHeaderValue value)	Append a portable typed header, retaining values with the same exact name.
MessageConfig.Builder<T>	addHeader(String name, String value)	Append a portable text header, retaining values with the same exact name.
MessageConfig.Builder<T>	addHeaders(List<? extends MessageHeader> headers)	Ordered portable headers.
MessageConfig.Builder<T>	addLocalMetadata(Map<String, ? extends MessageHeaderValue> localMetadata)	Metadata local to this message envelope.
protected final MessageConfig<T>	buildPrototype(MessageConfig.BuilderBase<T,?,?> builder)	Create a new prototype instance from a builder.
MessageConfig.Builder<T>	clearHeaders()	Clear all headers.
Optional<T>	entity()	Non-null message payload.
MessageConfig.Builder<T>	entity(T entity)	Non-null message payload.
MessageConfig.Builder<T>	from(MessageConfig.BuilderBase<T,?,?> builder)	Update this builder from an existing prototype builder instance.
MessageConfig.Builder<T>	from(MessageConfig<T> prototype)	Update this builder from an existing prototype instance.
MessageConfig.Builder<T>	header(String name, MessageHeaderValue value)	Set a portable typed header, replacing all values with the same exact name.
MessageConfig.Builder<T>	header(String name, String value)	Set a portable text header, replacing all values with the same exact name.
List<MessageHeader>	headers()	Ordered portable headers.
MessageConfig.Builder<T>	headers(MessageHeaders headers)	Replace all portable headers with the supplied immutable snapshot.
MessageConfig.Builder<T>	headers(Consumer<MessageHeaders.Builder> consumer)	Replace all portable headers using an initially empty headers builder.
MessageConfig.Builder<T>	headers(Supplier<? extends MessageHeaders> supplier)	Replace all portable headers using a supplier evaluated immediately.
MessageConfig.Builder<T>	headers(List<? extends MessageHeader> headers)	Ordered portable headers.
Map<String, MessageHeaderValue>	localMetadata()	Metadata local to this message envelope.
MessageConfig.Builder<T>	localMetadata(MessageMetadata localMetadata)	Replace all local metadata with the supplied immutable snapshot.
MessageConfig.Builder<T>	localMetadata(String key, MessageHeaderValue localMetadata)	Metadata local to this message envelope.
MessageConfig.Builder<T>	localMetadata(String name, String value)	Set a local text metadata value, replacing the value with the same exact name.
MessageConfig.Builder<T>	localMetadata(Consumer<MessageMetadata.Builder> consumer)	Replace all local metadata using an initially empty metadata builder.
MessageConfig.Builder<T>	localMetadata(Supplier<? extends MessageMetadata> supplier)	Replace all local metadata using a supplier evaluated immediately.
MessageConfig.Builder<T>	localMetadata(Map<String, ? extends MessageHeaderValue> localMetadata)	Metadata local to this message envelope.
protected void	preBuildPrototype()	Handles providers and decorators.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default Message<T>	get()
default MessageConfig.Builder<T>	identity()	Instance of this builder as the correct type.
default MessageConfig.Builder<T>	update(Consumer<MessageConfig.Builder<T>> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default MessageConfig.Builder<T>	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public MessageConfig<T> buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<MessageConfig.Builder<T>, MessageConfig<T>>

Returns:

an instance of the setup object created from this builder

build

public Message<T> build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<MessageConfig.Builder<T>, Message<T>>

Returns:

instance of the built type