Module io.helidon.json.smile

Package io.helidon.json.smile

Interface SmileConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

SmileConfig.BuilderBase.SmileConfigImpl

public interface SmileConfig
extends Prototype.Api

Configuration of Smile encoding and decoding.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SmileConfig.Builder	Fluent API builder for SmileConfig.
static class	SmileConfig.BuilderBase<BUILDER extends SmileConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends SmileConfig>	Fluent API builder base for SmileConfig.

Method Summary

Modifier and Type	Method	Description
static SmileConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static SmileConfig.Builder	builder(SmileConfig instance)	Create a new fluent API builder from an existing instance.
static SmileConfig	create()	Create a new instance with default values.
boolean	emitEndMark()	Whether to emit the optional Smile end marker when closing a generator.
boolean	rawBinaryEnabled()	Whether to allow raw binary values in Smile content.
boolean	sharedKeyStrings()	Whether to enable shared key string references.
boolean	sharedValueStrings()	Whether to enable shared value string references.

Method Details

builder

static SmileConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static SmileConfig.Builder builder(SmileConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static SmileConfig create()

Create a new instance with default values.

Returns:

a new instance

sharedKeyStrings

boolean sharedKeyStrings()

Whether to enable shared key string references.

Returns:

true to enable shared key string references, defaults to true

sharedValueStrings

boolean sharedValueStrings()

Whether to enable shared value string references.

Returns:

true to enable shared value string references

rawBinaryEnabled

boolean rawBinaryEnabled()

Whether to allow raw binary values in Smile content.

Returns:

true to allow raw binary values

emitEndMark

boolean emitEndMark()

Whether to emit the optional Smile end marker when closing a generator.

Returns:

true to emit the end marker