Module io.helidon.http.media.gson

Package io.helidon.http.media.gson

Class GsonSupport

java.lang.Object

io.helidon.http.media.gson.GsonSupport

All Implemented Interfaces:

RuntimeType.Api<GsonSupportConfig>, NamedService, MediaSupport

public class GsonSupport
extends Object
implements MediaSupport, RuntimeType.Api<GsonSupportConfig>

ServiceLoader provider implementation for Gson media support.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.http.media.MediaSupport

MediaSupport.ReaderResponse<T>, MediaSupport.SupportLevel, MediaSupport.WriterResponse<T>

Method Summary

Modifier and Type	Method	Description
static GsonSupportConfig.Builder	builder()	Creates a new builder.
static MediaSupport	create(com.google.gson.Gson gson)	Creates a new GsonSupport.
static MediaSupport	create(com.google.gson.Gson gson, String name)	Creates a new GsonSupport.
static MediaSupport	create(Config config)	Creates a new GsonSupport.
static MediaSupport	create(Config config, String name)	Creates a new GsonSupport.
static GsonSupport	create(GsonSupportConfig config)	Creates a new GsonSupport based on the GsonSupportConfig.
static GsonSupport	create(Consumer<GsonSupportConfig.Builder> consumer)	Creates a new customized GsonSupport.
String	name()	Name of this implementation, as provided in ConfiguredProvider.create(Config, String).
GsonSupportConfig	prototype()	The prototype as it was received when creating this runtime object instance.
<T> MediaSupport.ReaderResponse<T>	reader(GenericType<T> type, Headers requestHeaders)	Reader for an entity.
<T> MediaSupport.ReaderResponse<T>	reader(GenericType<T> type, Headers requestHeaders, Headers responseHeaders)	Client response reader.
String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().
<T> MediaSupport.WriterResponse<T>	writer(GenericType<T> type, Headers requestHeaders, WritableHeaders<?> responseHeaders)	Server response writer.
<T> MediaSupport.WriterResponse<T>	writer(GenericType<T> type, WritableHeaders<?> requestHeaders)	Client request writer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.http.media.MediaSupport

init

Method Details

create

public static MediaSupport create(Config config)

Creates a new GsonSupport.

Parameters:

config - must not be null

Returns:

a new GsonSupport

create

public static MediaSupport create(Config config,
 String name)

Creates a new GsonSupport.

Parameters:

config - must not be null

name - of the Gson support

Returns:

a new GsonSupport

create

public static MediaSupport create(com.google.gson.Gson gson)

Creates a new GsonSupport.

Parameters:

gson - must not be null

Returns:

a new GsonSupport

create

public static MediaSupport create(com.google.gson.Gson gson,
 String name)

Creates a new GsonSupport.

Parameters:

gson - must not be null

name - of the Gson support

Returns:

a new GsonSupport

create

public static GsonSupport create(GsonSupportConfig config)

Creates a new GsonSupport based on the GsonSupportConfig.

Parameters:

config - must not be null

Returns:

a new GsonSupport

create

public static GsonSupport create(Consumer<GsonSupportConfig.Builder> consumer)

Creates a new customized GsonSupport.

Parameters:

consumer - config builder consumer

Returns:

a new GsonSupport

builder

public static GsonSupportConfig.Builder builder()

Creates a new builder.

Returns:

a new builder instance

name

public String name()

Description copied from interface: NamedService

Name of this implementation, as provided in ConfiguredProvider.create(Config, String).

Specified by:

name in interface NamedService

Returns:

name of this service

type

public String type()

Description copied from interface: NamedService

Type of this implementation, to distinguish instances of same type, with different NamedService.name(). Use for example ConfiguredProvider.configKey() to define the type.

Specified by:

type in interface NamedService

Returns:

type of this service

reader

public <T> MediaSupport.ReaderResponse<T> reader(GenericType<T> type,
 Headers requestHeaders)

Description copied from interface: MediaSupport

Reader for an entity.

Specified by:

reader in interface MediaSupport

Type Parameters:

T - type

Parameters:

type - type of entity

requestHeaders - headers belonging to this entity (such as server request headers), expected to have content type

Returns:

reader response, whether this type is supported or not

reader

public <T> MediaSupport.ReaderResponse<T> reader(GenericType<T> type,
 Headers requestHeaders,
 Headers responseHeaders)

Description copied from interface: MediaSupport

Client response reader.

Specified by:

reader in interface MediaSupport

Type Parameters:

T - type

Parameters:

type - type of entity

requestHeaders - request headers

responseHeaders - response headers

Returns:

reader response, whether this type is supported or not

writer

public <T> MediaSupport.WriterResponse<T> writer(GenericType<T> type,
 Headers requestHeaders,
 WritableHeaders<?> responseHeaders)

Description copied from interface: MediaSupport

Server response writer.

Specified by:

writer in interface MediaSupport

Type Parameters:

T - type

Parameters:

type - type of entity

requestHeaders - request headers

responseHeaders - response headers

Returns:

writer response, whether this type is supported or not

writer

public <T> MediaSupport.WriterResponse<T> writer(GenericType<T> type,
 WritableHeaders<?> requestHeaders)

Description copied from interface: MediaSupport

Client request writer.

Specified by:

writer in interface MediaSupport

Type Parameters:

T - type

Parameters:

type - type of entity

requestHeaders - request headers

Returns:

writer response, whether this type is supported or not

prototype

public GsonSupportConfig prototype()

Description copied from interface: RuntimeType.Api

The prototype as it was received when creating this runtime object instance.

Specified by:

prototype in interface RuntimeType.Api<GsonSupportConfig>

Returns:

prototype object used to create this instance