Class MessageHeaders.Builder

java.lang.Object

io.helidon.messaging.MessageHeaders.Builder

All Implemented Interfaces:

Builder<MessageHeaders.Builder, MessageHeaders>, Supplier<MessageHeaders>

Enclosing interface:

MessageHeaders

public static final class MessageHeaders.Builder
extends Object
implements Builder<MessageHeaders.Builder, MessageHeaders>

Mutable messaging-header builder.

Method Summary

Modifier and Type	Method	Description
MessageHeaders.Builder	add(MessageHeader entry)	Append an entry.
MessageHeaders.Builder	add(String name, MessageHeaderValue value)	Append a value, retaining any entries with the same exact name.
MessageHeaders.Builder	add(String name, String value)	Append a text value, retaining any entries with the same exact name.
MessageHeaders.Builder	addAll(MessageHeaders headers)	Append all entries in their existing order.
MessageHeaders	build()	Create an immutable ordered snapshot.
MessageHeaders.Builder	clear()	Remove all entries.
MessageHeaders.Builder	from(MessageHeaders headers)	Append entries from existing headers in their current order.
MessageHeaders.Builder	remove(String name)	Remove every entry with an exact name.
MessageHeaders.Builder	set(String name, MessageHeaderValue value)	Replace all entries with an exact name and append one value.
MessageHeaders.Builder	set(String name, String value)	Replace all entries with an exact name and append one text value.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

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

Method Details

from

public MessageHeaders.Builder from(MessageHeaders headers)

Append entries from existing headers in their current order.

Parameters:

headers - existing headers

Returns:

updated builder

Throws:

NullPointerException - if headers is null

add

public MessageHeaders.Builder add(MessageHeader entry)

Append an entry.

Parameters:

entry - entry

Returns:

updated builder

add

public MessageHeaders.Builder add(String name,
 MessageHeaderValue value)

Append a value, retaining any entries with the same exact name.

Parameters:

name - exact header name

value - value

Returns:

updated builder

add

public MessageHeaders.Builder add(String name,
 String value)

Append a text value, retaining any entries with the same exact name.

Parameters:

name - exact header name

value - text value

Returns:

updated builder

addAll

public MessageHeaders.Builder addAll(MessageHeaders headers)

Append all entries in their existing order.

Parameters:

headers - headers

Returns:

updated builder

set

public MessageHeaders.Builder set(String name,
 MessageHeaderValue value)

Replace all entries with an exact name and append one value.

Parameters:

name - exact header name

value - value

Returns:

updated builder

set

public MessageHeaders.Builder set(String name,
 String value)

Replace all entries with an exact name and append one text value.

Parameters:

name - exact header name

value - text value

Returns:

updated builder

remove

public MessageHeaders.Builder remove(String name)

Remove every entry with an exact name.

Parameters:

name - exact header name

Returns:

updated builder

clear

public MessageHeaders.Builder clear()

Remove all entries.

Returns:

updated builder

build

public MessageHeaders build()

Create an immutable ordered snapshot.

Specified by:

build in interface Builder<MessageHeaders.Builder, MessageHeaders>

Returns:

headers