Module io.helidon.media.common

Package io.helidon.media.common

Class MediaContext.Builder

java.lang.Object

io.helidon.media.common.MediaContext.Builder

All Implemented Interfaces:

Builder<MediaContext>, MediaContextBuilder<MediaContext.Builder>, Supplier<MediaContext>

Enclosing class:

MediaContext

public static class MediaContext.Builder
extends Object
implements Builder<MediaContext>, MediaContextBuilder<MediaContext.Builder>

MediaSupport builder.

Method Summary

Modifier and Type	Method	Description
MediaContext.Builder	addMediaSupport(MediaSupport mediaSupport)	Adds new instance of MediaSupport.
MediaContext.Builder	addMediaSupport(MediaSupport mediaSupport, int priority)	Adds new instance of MediaSupport with specific priority.
MediaContext.Builder	addReader(MessageBodyReader<?> reader)	Registers new reader.
MediaContext.Builder	addStreamReader(MessageBodyStreamReader<?> streamReader)	Registers new stream reader.
MediaContext.Builder	addStreamWriter(MessageBodyStreamWriter<?> streamWriter)	Registers new stream writer.
MediaContext.Builder	addWriter(MessageBodyWriter<?> writer)	Registers new writer.
MediaContext	build()	Build the instance from this builder.
MediaContext.Builder	config(Config config)	Configures this MediaContext.Builder from the supplied Config.
MediaContext.Builder	discoverServices(boolean discoverServices)	Whether Java Service Loader should be used to load MediaSupportProvider.
MediaContext.Builder	filterServices(boolean filterServices)	Whether services loaded by Java Service Loader should be filtered.
MediaContext.Builder	registerDefaults(boolean registerDefaults)	Whether defaults should be included.

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

Methods inherited from interface io.helidon.media.common.MediaContextBuilder

addMediaSupport, addReader, addStreamReader, addStreamWriter, addWriter

Method Detail

config

public MediaContext.Builder config(Config config)

Configures this MediaContext.Builder from the supplied Config.

Optional configuration parameters

key	description
register-defaults	Whether to register default reader and writers
discover-services	Whether to discover services via service loader
filter-services	Whether to filter discovered services by service names in services section
services	Configuration section for each service. Each entry has to have "name" parameter. It is also used for filtering of loaded services.

Parameters:

config - a Config

Returns:

this MediaContext.Builder

addMediaSupport

public MediaContext.Builder addMediaSupport(MediaSupport mediaSupport)

Description copied from interface: MediaContextBuilder

Adds new instance of MediaSupport.

Specified by:

addMediaSupport in interface MediaContextBuilder<MediaContext.Builder>

Parameters:

mediaSupport - media support

Returns:

updated instance of the builder

addMediaSupport

public MediaContext.Builder addMediaSupport(MediaSupport mediaSupport,
                                            int priority)

Adds new instance of MediaSupport with specific priority.

Parameters:

mediaSupport - media support

priority - priority

Returns:

updated instance of the builder

addReader

public MediaContext.Builder addReader(MessageBodyReader<?> reader)

Description copied from interface: MediaContextBuilder

Registers new reader.

Specified by:

addReader in interface MediaContextBuilder<MediaContext.Builder>

Parameters:

reader - reader

Returns:

updated instance of the builder

addStreamReader

public MediaContext.Builder addStreamReader(MessageBodyStreamReader<?> streamReader)

Description copied from interface: MediaContextBuilder

Registers new stream reader.

Specified by:

addStreamReader in interface MediaContextBuilder<MediaContext.Builder>

Parameters:

streamReader - stream reader

Returns:

updated instance of the builder

addWriter

public MediaContext.Builder addWriter(MessageBodyWriter<?> writer)

Description copied from interface: MediaContextBuilder

Registers new writer.

Specified by:

addWriter in interface MediaContextBuilder<MediaContext.Builder>

Parameters:

writer - writer

Returns:

updated instance of the builder

addStreamWriter

public MediaContext.Builder addStreamWriter(MessageBodyStreamWriter<?> streamWriter)

Description copied from interface: MediaContextBuilder

Registers new stream writer.

Specified by:

addStreamWriter in interface MediaContextBuilder<MediaContext.Builder>

Parameters:

streamWriter - stream writer

Returns:

updated instance of the builder

registerDefaults

public MediaContext.Builder registerDefaults(boolean registerDefaults)

Whether defaults should be included.

Parameters:

registerDefaults - register defaults

Returns:

this builder instance

discoverServices

public MediaContext.Builder discoverServices(boolean discoverServices)

Whether Java Service Loader should be used to load MediaSupportProvider.

Parameters:

discoverServices - use Java Service Loader

Returns:

this builder instance

filterServices

public MediaContext.Builder filterServices(boolean filterServices)

Whether services loaded by Java Service Loader should be filtered. All of the services which should pass the filter, have to be present under services section of configuration.

Parameters:

filterServices - filter services

Returns:

this builder instance

build

public MediaContext build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<MediaContext>

Returns:

instance of the built type