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

Interface AnnotatedSettings.Builder

All Known Implementing Classes:

AnnotatedSettingsBuilderImpl

Enclosing interface:

AnnotatedSettings

public static interface AnnotatedSettings.Builder

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)

Method Detail

apply

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

useNamingConvention

AnnotatedSettings.Builder useNamingConvention(SettingNamingConvention convention)

collectMembersRecursively

AnnotatedSettings.Builder collectMembersRecursively()

collectOnlyAnnotatedMembers

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.

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

See Also:

Settings.onlyAnnotated()

collectMembersWith

AnnotatedSettings.Builder collectMembersWith(MemberCollector collector)

registerTypeMapping

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

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 registerTypeMapping(Class, ParameterizedTypeProcessor) instead.

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:

registerTypeMapping(Class, ParameterizedTypeProcessor), ConfigType

registerTypeMapping

<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. 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 registerTypeMapping(Class, ConfigType) instead.

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:

registerTypeMapping(Class, ConfigType), ParameterizedTypeProcessor

registerSettingProcessor

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

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

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

Throws:

IllegalArgumentException - if annotationType does not have RUNTIME retention

registerGroupProcessor

<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.

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

Throws:

IllegalArgumentException - if annotationType does not have RUNTIME retention

registerConstraintProcessor

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

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

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

Throws:

IllegalArgumentException - if annotationType does not have RUNTIME retention

build

AnnotatedSettings build()