Class WsClientProtocolConfig.Builder

java.lang.Object

io.helidon.websocket.WsProtocolConfig.BuilderBase<WsClientProtocolConfig.Builder, WsClientProtocolConfig>

io.helidon.webclient.websocket.WsClientProtocolConfig.BuilderBase<WsClientProtocolConfig.Builder, WsClientProtocolConfig>

io.helidon.webclient.websocket.WsClientProtocolConfig.Builder

All Implemented Interfaces:

Prototype.Builder<WsClientProtocolConfig.Builder, WsClientProtocolConfig>, Builder<WsClientProtocolConfig.Builder, WsClientProtocolConfig>, ConfigBuilderSupport.ConfiguredBuilder<WsClientProtocolConfig.Builder, WsClientProtocolConfig>, Supplier<WsClientProtocolConfig>

Enclosing interface:

WsClientProtocolConfig

public static class WsClientProtocolConfig.Builder
extends WsClientProtocolConfig.BuilderBase<WsClientProtocolConfig.Builder, WsClientProtocolConfig>
implements Builder<WsClientProtocolConfig.Builder, WsClientProtocolConfig>

Fluent API builder for WsClientProtocolConfig.

Nested Class Summary

Nested classes/interfaces inherited from class WsClientProtocolConfig.BuilderBase

WsClientProtocolConfig.BuilderBase.WsClientProtocolConfigImpl

Modifier and Type	Class	Description
protected static class	WsClientProtocolConfig.BuilderBase.WsClientProtocolConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested classes/interfaces inherited from class WsProtocolConfig.BuilderBase

WsProtocolConfig.BuilderBase.WsProtocolConfigImpl

Modifier and Type	Class	Description
protected static class	WsProtocolConfig.BuilderBase.WsProtocolConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Method Summary

Modifier and Type	Method	Description
WsClientProtocolConfig	build()	Create an instance from this builder.
WsClientProtocolConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class WsClientProtocolConfig.BuilderBase

addSubProtocol, addSubProtocols, clearSubProtocols, config, from, from, name, name, preBuildPrototype, subProtocols, subProtocols, toString, validatePrototype

Modifier and Type	Method	Description
WsClientProtocolConfig.Builder	addSubProtocol(String subProtocol)	WebSocket sub-protocols requested by the client.
WsClientProtocolConfig.Builder	addSubProtocols(List<String> subProtocols)	WebSocket sub-protocols requested by the client.
WsClientProtocolConfig.Builder	clearSubProtocols()	Clear all subProtocols.
WsClientProtocolConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
WsClientProtocolConfig.Builder	from(WsClientProtocolConfig prototype)	Update this builder from an existing prototype instance.
WsClientProtocolConfig.Builder	from(WsClientProtocolConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
String	name()	Name of this protocol configuration.
WsClientProtocolConfig.Builder	name(String name)	Name of this protocol configuration.
protected void	preBuildPrototype()	Handles providers and decorators.
List<String>	subProtocols()	WebSocket sub-protocols requested by the client.
WsClientProtocolConfig.Builder	subProtocols(List<String> subProtocols)	WebSocket sub-protocols requested by the client.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class WsProtocolConfig.BuilderBase

config, from, from, maxBufferedMessageSize, maxBufferedMessageSize

Modifier and Type	Method	Description
protected Optional<Config>	config()	Configuration used to configure this instance.
WsClientProtocolConfig.Builder	from(WsProtocolConfig prototype)	Update this builder from an existing prototype instance.
WsClientProtocolConfig.Builder	from(WsProtocolConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Size	maxBufferedMessageSize()	Maximum size of a WebSocket message buffered for delivery to a listener.
WsClientProtocolConfig.Builder	maxBufferedMessageSize(Size maxBufferedMessageSize)	Maximum size of a WebSocket message buffered for delivery to a listener.

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 WsClientProtocolConfig	get()
default WsClientProtocolConfig.Builder	identity()	Instance of this builder as the correct type.
default WsClientProtocolConfig.Builder	update(Consumer<WsClientProtocolConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default WsClientProtocolConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public WsClientProtocolConfig 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<WsClientProtocolConfig.Builder, WsClientProtocolConfig>

Returns:

an instance of the setup object created from this builder

build

public WsClientProtocolConfig 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<WsClientProtocolConfig.Builder, WsClientProtocolConfig>

Returns:

instance of the built type