Interface GsonComponentSerializer.Builder

All Superinterfaces:

AbstractBuilder<GsonComponentSerializer>, JSONComponentSerializer.Builder

Enclosing interface:

GsonComponentSerializer

public static interface GsonComponentSerializer.Builder
extends AbstractBuilder<GsonComponentSerializer>, JSONComponentSerializer.Builder

A builder for GsonComponentSerializer.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
GsonComponentSerializer	build()	Builds the serializer.
GsonComponentSerializer.Builder	editOptions(Consumer<net.kyori.option.OptionState.Builder> optionEditor)	Edit the active set of serializer options.
GsonComponentSerializer.Builder	legacyHoverEventSerializer(@Nullable LegacyHoverEventSerializer serializer)	Sets a serializer that will be used to interpret legacy hover event value payloads.
GsonComponentSerializer.Builder	options(net.kyori.option.OptionState flags)	Set the option state to apply on this serializer.

Method Details

options

GsonComponentSerializer.Builder options(net.kyori.option.OptionState flags)

Description copied from interface: JSONComponentSerializer.Builder

Set the option state to apply on this serializer.

This controls how the serializer emits and interprets components.

Specified by:

options in interface JSONComponentSerializer.Builder

Parameters:

flags - the flag set to use

Returns:

this builder

See Also:

• JSONOptions

editOptions

GsonComponentSerializer.Builder editOptions(Consumer<net.kyori.option.OptionState.Builder> optionEditor)

Description copied from interface: JSONComponentSerializer.Builder

Edit the active set of serializer options.

Specified by:

editOptions in interface JSONComponentSerializer.Builder

Parameters:

optionEditor - the consumer operating on the existing flag set

Returns:

this builder

See Also:

• JSONOptions

legacyHoverEventSerializer

GsonComponentSerializer.Builder legacyHoverEventSerializer(@Nullable LegacyHoverEventSerializer serializer)

Description copied from interface: JSONComponentSerializer.Builder

Sets a serializer that will be used to interpret legacy hover event value payloads. If the serializer is null, then only HoverEvent.Action.SHOW_TEXT legacy hover events can be deserialized.

Specified by:

legacyHoverEventSerializer in interface JSONComponentSerializer.Builder

Parameters:

serializer - serializer

Returns:

this builder

build

GsonComponentSerializer build()

Builds the serializer.

Specified by:

build in interface AbstractBuilder<GsonComponentSerializer>

Specified by:

build in interface JSONComponentSerializer.Builder

Returns:

the built serializer