io.github.fablabsmc.fablabs.impl.fiber.annotation

Class AnnotatedSettingsBuilderImpl

java.lang.Object

io.github.fablabsmc.fablabs.impl.fiber.annotation.AnnotatedSettingsBuilderImpl

All Implemented Interfaces:

AnnotatedSettings.Builder

public final class AnnotatedSettingsBuilderImpl
extends Object
implements AnnotatedSettings.Builder

Constructor Summary

Constructors

Constructor and Description
AnnotatedSettingsBuilderImpl()

Method Summary

Modifier and Type	Method and Description
AnnotatedSettings.Builder	apply(Consumer<AnnotatedSettings.Builder> configuration)
AnnotatedSettings	build()
AnnotatedSettings.Builder	collectMembersRecursively()
AnnotatedSettings.Builder	collectMembersWith(MemberCollector collector)
AnnotatedSettings.Builder	collectOnlyAnnotatedMembers() Specifies whether or not all fields in processed classes should be considered as config value candidates, or only those annotated with Setting.
<A extends Annotation> AnnotatedSettings.Builder	registerConstraintProcessor(Class<A> annotationType, ConstraintAnnotationProcessor<A> processor) Registers a constraint annotation processor, tasked with processing annotations on config types.
<A extends Annotation> AnnotatedSettings.Builder	registerGroupProcessor(Class<A> annotationType, BranchAnnotationProcessor<A> processor) Registers a group annotation processor, tasked with processing annotations on ancestor fields (config fields annotated with Setting.Group.
<A extends Annotation> AnnotatedSettings.Builder	registerSettingProcessor(Class<A> annotationType, LeafAnnotationProcessor<A> processor) Registers a setting annotation processor, tasked with processing annotations on config fields.
<T> AnnotatedSettings.Builder	registerTypeMapping(Class<? super T> clazz, ConfigType<T,?,?> type) Registers a type mapping from a Java type to a ConfigType.
<T> AnnotatedSettings.Builder	registerTypeMapping(Class<? super T> clazz, ParameterizedTypeProcessor<T> processor) Registers a type mapping from a parameterized Java type to a family of ConfigType.
AnnotatedSettings.Builder	useNamingConvention(SettingNamingConvention convention)

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotatedSettingsBuilderImpl

public AnnotatedSettingsBuilderImpl()

Method Detail

apply

public AnnotatedSettings.Builder apply(Consumer<AnnotatedSettings.Builder> configuration)

Specified by:

apply in interface AnnotatedSettings.Builder

collectMembersRecursively

public AnnotatedSettings.Builder collectMembersRecursively()

Specified by:

collectMembersRecursively in interface AnnotatedSettings.Builder

collectOnlyAnnotatedMembers

public AnnotatedSettings.Builder collectOnlyAnnotatedMembers()

Description copied from interface: AnnotatedSettings.Builder

Specifies whether or not all fields in processed classes should be considered as config value candidates, or only those annotated with Setting.

This setting has no effect on classes annotated with @Settings, as it is superseded by Settings.onlyAnnotated().

Specified by:

collectOnlyAnnotatedMembers in interface AnnotatedSettings.Builder

See Also:

Settings.onlyAnnotated()

collectMembersWith

public AnnotatedSettings.Builder collectMembersWith(MemberCollector collector)

Specified by:

collectMembersWith in interface AnnotatedSettings.Builder

useNamingConvention

public AnnotatedSettings.Builder useNamingConvention(SettingNamingConvention convention)

Specified by:

useNamingConvention in interface AnnotatedSettings.Builder

registerTypeMapping

public <T> AnnotatedSettings.Builder registerTypeMapping(Class<? super T> clazz,
                                                         ConfigType<T,?,?> type)

Description copied from interface: AnnotatedSettings.Builder

Registers a type mapping from a Java type to a ConfigType. Fields of the given type in POJOs are mapped to nodes storing values of the given ConfigType.

This method should be used to register type mappings for non-parameterized types. For registering type mappings for parameterized types, use AnnotatedSettings.Builder.registerTypeMapping(Class, ParameterizedTypeProcessor) instead.

Specified by:

registerTypeMapping in interface AnnotatedSettings.Builder

Type Parameters:

T - The type of fields to map.

Parameters:

clazz - The Class object for the type of fields to map.

type - The mapped to ConfigType.

Returns:

This instance.

See Also:

AnnotatedSettings.Builder.registerTypeMapping(Class, ParameterizedTypeProcessor), ConfigType

registerTypeMapping

public <T> AnnotatedSettings.Builder registerTypeMapping(Class<? super T> clazz,
                                                         ParameterizedTypeProcessor<T> processor)

Description copied from interface: AnnotatedSettings.Builder

Registers a type mapping from a parameterized Java type to a family of ConfigType. Fields of instantiations of the given type are mapped to nodes storing values of ConfigType created via the given ParameterizedTypeProcessor.

This method should be used to register type mappings for parameterized types. For registering type mappings for non-parameterized types, use AnnotatedSettings.Builder.registerTypeMapping(Class, ConfigType) instead.

Specified by:

registerTypeMapping in interface AnnotatedSettings.Builder

Type Parameters:

T - The type of fields to map.

Parameters:

clazz - The Class object for the type of fields to map.

processor - A function taking actual type arguments and returning a suitable ConfigType.

Returns:

This instance.

See Also:

AnnotatedSettings.Builder.registerTypeMapping(Class, ConfigType), ParameterizedTypeProcessor

registerSettingProcessor

public <A extends Annotation> AnnotatedSettings.Builder registerSettingProcessor(Class<A> annotationType,
                                                                                 LeafAnnotationProcessor<A> processor)

Registers a setting annotation processor, tasked with processing annotations on config fields.

Specified by:

registerSettingProcessor in interface AnnotatedSettings.Builder

Type Parameters:

A - the type of annotation to process

Parameters:

annotationType - a class representing the type of annotation to process

processor - a processor for this annotation

Returns:

this, for chaining

registerGroupProcessor

public <A extends Annotation> AnnotatedSettings.Builder registerGroupProcessor(Class<A> annotationType,
                                                                               BranchAnnotationProcessor<A> processor)

Registers a group annotation processor, tasked with processing annotations on ancestor fields (config fields annotated with Setting.Group.

Specified by:

registerGroupProcessor in interface AnnotatedSettings.Builder

Type Parameters:

A - the type of annotation to process

Parameters:

annotationType - a class representing the type of annotation to process

processor - a processor for this annotation

Returns:

this, for chaining

registerConstraintProcessor

public <A extends Annotation> AnnotatedSettings.Builder registerConstraintProcessor(Class<A> annotationType,
                                                                                    ConstraintAnnotationProcessor<A> processor)

Registers a constraint annotation processor, tasked with processing annotations on config types.

Specified by:

registerConstraintProcessor in interface AnnotatedSettings.Builder

Type Parameters:

A - the type of annotation to process

Parameters:

annotationType - a class representing the type of annotation to process

processor - a processor for this annotation

Returns:

this, for chaining

build

public AnnotatedSettings build()

Specified by:

build in interface AnnotatedSettings.Builder