io.github.fablabsmc.fablabs.api.fiber.v1.annotation

Interface AnnotatedSettings

All Known Implementing Classes:

AnnotatedSettingsImpl

public interface AnnotatedSettings

Types which implement this interface can create a config tree based on an annotated POJO "plain old Java object" representation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AnnotatedSettings.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static AnnotatedSettings	DEFAULT_SETTINGS A provided AnnotatedSettings with configuration suitable for deserializing types supported in Fiber.

Method Summary

Modifier and Type	Method and Description
<P> void	applyToNode(ConfigTree mergeTo, P pojo) Applies the schema defined by pojo to the given ConfigTree.
static AnnotatedSettings.Builder	builder() Returns a annotated settings builder.
ConfigBranch	makeTree(Object pojo) Creates a config tree based on the given argument.

Field Detail

DEFAULT_SETTINGS

static final AnnotatedSettings DEFAULT_SETTINGS

A provided AnnotatedSettings with configuration suitable for deserializing types supported in Fiber.

See Also:

builder()

Method Detail

builder

static AnnotatedSettings.Builder builder()

Returns a annotated settings builder.

See Also:

AnnotatedSettings.Builder

makeTree

ConfigBranch makeTree(Object pojo)
               throws FiberException

Creates a config tree based on the given argument.

Parameters:

pojo - The config schema.

Returns:

A config tree defined by the representation.

Throws:

FiberException - If pojo cannot be parsed.

applyToNode

<P> void applyToNode(ConfigTree mergeTo,
                     P pojo)
              throws FiberException

Applies the schema defined by pojo to the given ConfigTree.

Type Parameters:

P - The type of the pojo.

Parameters:

mergeTo - The config tree.

pojo - The config schema.

Throws:

FiberException - If pojo cannot be parsed.