ch.jalu.configme.configurationdata

Class ConfigurationDataBuilder

java.lang.Object

ch.jalu.configme.configurationdata.ConfigurationDataBuilder

public class ConfigurationDataBuilder
extends Object

Utility class responsible for retrieving all Property fields from SettingsHolder implementations via reflection.

Properties must be declared as public static fields or they are ignored.

Field Summary

Fields

Modifier and Type	Field and Description
protected @NotNull CommentsConfiguration	commentsConfiguration
protected @NotNull PropertyListBuilder	propertyListBuilder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigurationDataBuilder()

Method Summary

Modifier and Type	Method and Description
protected @NotNull ConfigurationData	collectData(@NotNull Iterable<Class<? extends SettingsHolder>> classes) Collects property data and comment info from the given class and creates a configuration data instance with it.
protected void	collectProperties(@NotNull Class<?> clazz) Registers all property fields of the given class to this instance's property list builder.
protected void	collectSectionComments(@NotNull Class<? extends SettingsHolder> clazz)
static @NotNull ConfigurationData	createConfiguration(Class<? extends SettingsHolder>... classes) Collects all properties and comment data from the provided classes.
static @NotNull ConfigurationData	createConfiguration(@NotNull Iterable<Class<? extends SettingsHolder>> classes) Collects all properties and comment data from the provided classes.
static @NotNull ConfigurationData	createConfiguration(@NotNull List<? extends Property<?>> properties)
static @NotNull ConfigurationData	createConfiguration(@NotNull List<? extends Property<?>> properties, @NotNull CommentsConfiguration commentsConfiguration)
protected <T extends SettingsHolder> T	createSettingsHolderInstance(@NotNull Class<T> clazz) Creates an instance of the given settings holder class.
protected @NotNull Stream<Field>	findFieldsToProcess(@NotNull Class<?> clazz) Returns all fields of the class which should be considered as potential Property definitions.
protected @Nullable Property<?>	getPropertyField(@NotNull Field field) Returns the given field's value if it is a static Property.
protected void	setCommentForPropertyField(@NotNull Field field, @NotNull String path)
protected void	setFieldAccessibleIfNeeded(@NotNull Field field) Sets the Field object to be accessible if needed; this makes the code support constants in Kotlin without the @JvmField annotation.

Methods inherited from class java.lang.Object

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

Field Detail

propertyListBuilder

@NotNull
protected @NotNull PropertyListBuilder propertyListBuilder

commentsConfiguration

@NotNull
protected @NotNull CommentsConfiguration commentsConfiguration

Constructor Detail

ConfigurationDataBuilder

protected ConfigurationDataBuilder()

Method Detail

createConfiguration

@SafeVarargs
 @NotNull
public static @NotNull ConfigurationData createConfiguration(@NotNull
                                                                                    Class<? extends SettingsHolder>... classes)

Collects all properties and comment data from the provided classes. Properties are sorted by their group, and each group is sorted by order of encounter.

Parameters:

classes - the classes to scan for their property data

Returns:

collected configuration data

createConfiguration

@NotNull
public static @NotNull ConfigurationData createConfiguration(@NotNull
                                                                      @NotNull Iterable<Class<? extends SettingsHolder>> classes)

Collects all properties and comment data from the provided classes. Properties are sorted by their group, and each group is sorted by order of encounter.

Parameters:

classes - the classes to scan for their property data

Returns:

collected configuration data

createConfiguration

@NotNull
public static @NotNull ConfigurationData createConfiguration(@NotNull
                                                                      @NotNull List<? extends Property<?>> properties)

createConfiguration

@NotNull
public static @NotNull ConfigurationData createConfiguration(@NotNull
                                                                      @NotNull List<? extends Property<?>> properties,
                                                                      @NotNull
                                                                      @NotNull CommentsConfiguration commentsConfiguration)

collectData

@NotNull
protected @NotNull ConfigurationData collectData(@NotNull
                                                          @NotNull Iterable<Class<? extends SettingsHolder>> classes)

Collects property data and comment info from the given class and creates a configuration data instance with it.

Parameters:

classes - the classes to process

Returns:

configuration data with the classes' data

collectProperties

protected void collectProperties(@NotNull
                                 @NotNull Class<?> clazz)

Registers all property fields of the given class to this instance's property list builder.

Parameters:

clazz - the class to process

setCommentForPropertyField

protected void setCommentForPropertyField(@NotNull
                                          @NotNull Field field,
                                          @NotNull
                                          @NotNull String path)

getPropertyField

@Nullable
protected @Nullable Property<?> getPropertyField(@NotNull
                                                           @NotNull Field field)

Returns the given field's value if it is a static Property.

Parameters:

field - the field's value to return

Returns:

the property the field defines, or null if not applicable

setFieldAccessibleIfNeeded

protected void setFieldAccessibleIfNeeded(@NotNull
                                          @NotNull Field field)

Sets the Field object to be accessible if needed; this makes the code support constants in Kotlin without the @JvmField annotation. This method only calls AccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean) if it is needed to avoid potential issues with a security manager. Within Java itself, only public static final property fields are expected.

Parameters:

field - the field to process

collectSectionComments

protected void collectSectionComments(@NotNull
                                      @NotNull Class<? extends SettingsHolder> clazz)

createSettingsHolderInstance

@NotNull
protected <T extends SettingsHolder> T createSettingsHolderInstance(@NotNull
                                                                             @NotNull Class<T> clazz)

Creates an instance of the given settings holder class.

Type Parameters:

T - the class type

Parameters:

clazz - the class to instantiate

Returns:

instance of the class

findFieldsToProcess

@NotNull
protected @NotNull Stream<Field> findFieldsToProcess(@NotNull
                                                              @NotNull Class<?> clazz)

Returns all fields of the class which should be considered as potential Property definitions. Considers the class's parents.

Parameters:

clazz - the class whose fields should be returned

Returns:

stream of all the fields to process