Module io.helidon.http.media.gson

Package io.helidon.http.media.gson

Class GsonSupportConfig.BuilderBase<BUILDER extends GsonSupportConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends GsonSupportConfig>

java.lang.Object

io.helidon.http.media.MediaSupportConfig.BuilderBase<BUILDER,PROTOTYPE>

io.helidon.http.media.gson.GsonSupportConfig.BuilderBase<BUILDER,PROTOTYPE>

Type Parameters:

BUILDER - type of the builder extending this abstract builder

PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()

All Implemented Interfaces:

Prototype.Builder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Direct Known Subclasses:

GsonSupportConfig.Builder

Enclosing interface:

GsonSupportConfig

public abstract static class GsonSupportConfig.BuilderBase<BUILDER extends GsonSupportConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends GsonSupportConfig>
extends MediaSupportConfig.BuilderBase<BUILDER,PROTOTYPE>
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Fluent API builder base for GsonSupportConfig.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class io.helidon.http.media.MediaSupportConfig.BuilderBase

MediaSupportConfig.BuilderBase.MediaSupportConfigImpl

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
BUILDER	addProperties(Map<String,Boolean> properties)	Gson configuration properties.
BUILDER	addTypeAdapterFactories(List<? extends com.google.gson.TypeAdapterFactory> typeAdapterFactories)	Additional type adapter factories.
BUILDER	addTypeAdapterFactory(com.google.gson.TypeAdapterFactory typeAdapterFactory)	Additional type adapter factories.
BUILDER	clearTypeAdapterFactories()	Clear all typeAdapterFactories.
BUILDER	config(Config config)	Deprecated. use config(io.helidon.config.Config)
BUILDER	config(Config config)	Update builder from configuration (node of this type).
BUILDER	from(GsonSupportConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(GsonSupportConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<com.google.gson.Gson>	gson()	Gson instance.
BUILDER	gson(com.google.gson.Gson gson)	Gson instance.
protected void	preBuildPrototype()	Handles providers and decorators.
Map<String,Boolean>	properties()	Gson configuration properties.
BUILDER	properties(Map<String,Boolean> properties)	Gson configuration properties.
BUILDER	putProperty(String key, Boolean property)	Gson configuration properties.
Optional<ServiceRegistry>	serviceRegistry()	Service registry used to discover providers and services.
BUILDER	serviceRegistry(ServiceRegistry serviceRegistry)	Service registry used to discover providers and services.
String	toString()
List<com.google.gson.TypeAdapterFactory>	typeAdapterFactories()	Additional type adapter factories.
BUILDER	typeAdapterFactories(List<? extends com.google.gson.TypeAdapterFactory> typeAdapterFactories)	Additional type adapter factories.
boolean	typeAdapterFactoriesDiscoverServices()	Service discovery flag for typeAdapterFactories().
BUILDER	typeAdapterFactoriesDiscoverServices(boolean typeAdapterFactoriesDiscoverServices)	Service discovery flag for typeAdapterFactories().
protected void	validatePrototype()	Validates required properties.

Methods inherited from class io.helidon.http.media.MediaSupportConfig.BuilderBase

acceptedMediaTypes, acceptedMediaTypes, addAcceptedMediaType, addAcceptedMediaTypes, clearAcceptedMediaTypes, config, contentType, contentType, contentType, contentType, from, from, name, name

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.builder.api.Prototype.Builder

buildPrototype, self

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(GsonSupportConfig prototype)

Update this builder from an existing prototype instance. This method disables automatic service discovery.

Parameters:

prototype - existing prototype to update this builder from

Returns:

updated builder instance

from

public BUILDER from(GsonSupportConfig.BuilderBase<?,?> builder)

Update this builder from an existing prototype builder instance.

Parameters:

builder - existing builder prototype to update this builder from

Returns:

updated builder instance

config

@Deprecated
public BUILDER config(Config config)

Deprecated.

use config(io.helidon.config.Config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends GsonSupportConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends GsonSupportConfig>

Overrides:

config in class MediaSupportConfig.BuilderBase<BUILDER extends GsonSupportConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends GsonSupportConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

config

public BUILDER config(Config config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends GsonSupportConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends GsonSupportConfig>

Overrides:

config in class MediaSupportConfig.BuilderBase<BUILDER extends GsonSupportConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends GsonSupportConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

gson

public BUILDER gson(com.google.gson.Gson gson)

Gson instance.

Parameters:

gson - gson instance

Returns:

updated builder instance

See Also:

• gson()

properties

public BUILDER properties(Map<String,Boolean> properties)

Gson configuration properties. Properties are being ignored if specific Gson is set. Only boolean configuration values are supported. This method replaces all values with the new ones.

Parameters:

properties - gson config properties

Returns:

updated builder instance

See Also:

• properties()

addProperties

public BUILDER addProperties(Map<String,Boolean> properties)

Gson configuration properties. Properties are being ignored if specific Gson is set. Only boolean configuration values are supported. This method keeps existing values, then puts all new values into the map.

Parameters:

properties - gson config properties

Returns:

updated builder instance

See Also:

• properties()

putProperty

public BUILDER putProperty(String key,
 Boolean property)

Gson configuration properties. Properties are being ignored if specific Gson is set. Only boolean configuration values are supported. This method adds a new value to the map, or replaces it if the key already exists.

Parameters:

key - key to add or replace

property - new value for the key

Returns:

updated builder instance

See Also:

• properties()

clearTypeAdapterFactories

public BUILDER clearTypeAdapterFactories()

Clear all typeAdapterFactories.

Returns:

updated builder instance

See Also:

• typeAdapterFactories()

typeAdapterFactories

public BUILDER typeAdapterFactories(List<? extends com.google.gson.TypeAdapterFactory> typeAdapterFactories)

Additional type adapter factories.

Parameters:

typeAdapterFactories - type adapter factories

Returns:

updated builder instance

See Also:

• typeAdapterFactories()

addTypeAdapterFactories

public BUILDER addTypeAdapterFactories(List<? extends com.google.gson.TypeAdapterFactory> typeAdapterFactories)

Additional type adapter factories.

Parameters:

typeAdapterFactories - type adapter factories

Returns:

updated builder instance

See Also:

• typeAdapterFactories()

addTypeAdapterFactory

public BUILDER addTypeAdapterFactory(com.google.gson.TypeAdapterFactory typeAdapterFactory)

Additional type adapter factories.

Parameters:

typeAdapterFactory - add single type adapter factories

Returns:

updated builder instance

See Also:

• typeAdapterFactories()

typeAdapterFactoriesDiscoverServices

public BUILDER typeAdapterFactoriesDiscoverServices(boolean typeAdapterFactoriesDiscoverServices)

Service discovery flag for typeAdapterFactories(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.

Parameters:

typeAdapterFactoriesDiscoverServices - whether to enable automatic service discovery

Returns:

updated builder instance

See Also:

• typeAdapterFactoriesDiscoverServices()

serviceRegistry

public BUILDER serviceRegistry(ServiceRegistry serviceRegistry)

Service registry used to discover providers and services. Provide an explicit registry instance to use.

If not configured, the GlobalServiceRegistry would be used to discover services.

Parameters:

serviceRegistry - service registry to use

Returns:

updated builder instance

See Also:

• serviceRegistry()

gson

public Optional<com.google.gson.Gson> gson()

Gson instance.

Returns:

gson instance

properties

public Map<String,Boolean> properties()

Gson configuration properties. Properties are being ignored if specific Gson is set. Only boolean configuration values are supported.

Returns:

gson config properties

typeAdapterFactories

public List<com.google.gson.TypeAdapterFactory> typeAdapterFactories()

Additional type adapter factories.

Returns:

type adapter factories

typeAdapterFactoriesDiscoverServices

public boolean typeAdapterFactoriesDiscoverServices()

Service discovery flag for typeAdapterFactories(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.

Returns:

whether to enable automatic service discovery

serviceRegistry

public Optional<ServiceRegistry> serviceRegistry()

Service registry used to discover providers and services. Provide an explicit registry instance to use.

If not configured, the GlobalServiceRegistry would be used to discover services.

Returns:

service registry to use

toString

public String toString()

Overrides:

toString in class MediaSupportConfig.BuilderBase<BUILDER extends GsonSupportConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends GsonSupportConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class MediaSupportConfig.BuilderBase<BUILDER extends GsonSupportConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends GsonSupportConfig>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class MediaSupportConfig.BuilderBase<BUILDER extends GsonSupportConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends GsonSupportConfig>