Module io.helidon.media.common

Package io.helidon.media.common

Class MediaSupport.Builder

java.lang.Object

io.helidon.media.common.MediaSupport.Builder

All Implemented Interfaces:

Builder<MediaSupport>, Supplier<MediaSupport>

Enclosing class:

MediaSupport

public static final class MediaSupport.Builder
extends Object
implements Builder<MediaSupport>

MediaSupport builder.

Method Summary

Modifier and Type	Method	Description
MediaSupport	build()	Build the instance from this builder.
MediaSupport.Builder	config(Config config)	Configures this MediaSupport.Builder from the supplied Config.
MediaSupport.Builder	registerDefaults()	Register the default readers and writers.
MediaSupport.Builder	registerInboundFilter(MessageBodyFilter filter)	Register a new filter on the reader context (inbound payload).
MediaSupport.Builder	registerOutboundFilter(MessageBodyFilter filter)	Register a new filter on the writer context (outbound payload).
MediaSupport.Builder	registerReader(MessageBodyReader<?> reader)	Register a new reader.
MediaSupport.Builder	registerStreamReader(MessageBodyStreamReader<?> reader)	Register a new stream reader.
MediaSupport.Builder	registerStreamWriter(MessageBodyStreamWriter<?> writer)	Register a new stream writer.
MediaSupport.Builder	registerWriter(MessageBodyWriter<?> writer)	Register a new writer.
MediaSupport.Builder	serverErrorsIncludeStackTraces(boolean serverErrorsIncludeStackTraces)	Ensures that MediaSupport instances built by this MediaSupport.Builder will include stack trace information when server errors are returned.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get

Method Detail

config

public MediaSupport.Builder config(Config config)

Configures this MediaSupport.Builder from the supplied Config.

Parameters:

config - a Config

Returns:

this MediaSupport.Builder

serverErrorsIncludeStackTraces

public MediaSupport.Builder serverErrorsIncludeStackTraces(boolean serverErrorsIncludeStackTraces)

Ensures that MediaSupport instances built by this MediaSupport.Builder will include stack trace information when server errors are returned.

Parameters:

serverErrorsIncludeStackTraces - whether stack trace information should be included

Returns:

this MediaSupport.Builder

registerDefaults

public MediaSupport.Builder registerDefaults()

Register the default readers and writers.

Default readers

• StringBodyReader - converts payload into String.class
• InputStreamBodyReader - converts payload into InputStream.class

Default writers

• CharSequenceBodyWriter - generates payload from CharSequence.class
• ByteChannelBodyWriter - generates payload from ReadableByteChannel.class
• PathBodyWriter - generates payload from Path.class
• FileBodyWriter - generates payload from File.class
• ThrowableBodyWriter - generates payload from Throwable.class

Returns:

this MediaSupport.Builder

registerReader

public MediaSupport.Builder registerReader(MessageBodyReader<?> reader)

Register a new reader.

Parameters:

reader - reader to register

Returns:

this builder instance

registerStreamReader

public MediaSupport.Builder registerStreamReader(MessageBodyStreamReader<?> reader)

Register a new stream reader.

Parameters:

reader - reader to register

Returns:

this builder instance

registerInboundFilter

public MediaSupport.Builder registerInboundFilter(MessageBodyFilter filter)

Register a new filter on the reader context (inbound payload).

Parameters:

filter - filter to register

Returns:

this builder instance

registerWriter

public MediaSupport.Builder registerWriter(MessageBodyWriter<?> writer)

Register a new writer.

Parameters:

writer - writer to register

Returns:

this builder instance

registerStreamWriter

public MediaSupport.Builder registerStreamWriter(MessageBodyStreamWriter<?> writer)

Register a new stream writer.

Parameters:

writer - writer to register

Returns:

this builder instance

registerOutboundFilter

public MediaSupport.Builder registerOutboundFilter(MessageBodyFilter filter)

Register a new filter on the writer context (outbound payload).

Parameters:

filter - filter to register

Returns:

this builder instance

build

public MediaSupport build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<MediaSupport>

Returns:

instance of the built type