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 CommentsConfiguration	commentsConfiguration
protected PropertyListBuilder	propertyListBuilder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigurationDataBuilder()

Method Summary

Modifier and Type	Method and Description
protected ConfigurationData	collectData(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(Class<?> clazz) Registers all property fields of the given class to this instance's property list builder.
protected void	collectSectionComments(Class<? extends SettingsHolder> clazz)
static ConfigurationData	createConfiguration(Class<? extends SettingsHolder>... classes) Collects all properties and comment data from the provided classes.
static ConfigurationData	createConfiguration(Iterable<Class<? extends SettingsHolder>> classes) Collects all properties and comment data from the provided classes.
static ConfigurationData	createConfiguration(List<? extends Property<?>> properties)
static ConfigurationData	createConfiguration(List<? extends Property<?>> properties, CommentsConfiguration commentsConfiguration)
protected <T extends SettingsHolder> T	createSettingsHolderInstance(Class<T> clazz) Creates an instance of the given settings holder class.
protected Property<?>	getPropertyField(Field field) Returns the given field's value if it is a static Property.
protected void	setCommentForPropertyField(Field field, String path)

Methods inherited from class java.lang.Object

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

Field Detail

propertyListBuilder

protected PropertyListBuilder propertyListBuilder

commentsConfiguration

protected CommentsConfiguration commentsConfiguration

Constructor Detail

ConfigurationDataBuilder

protected ConfigurationDataBuilder()

Method Detail

createConfiguration

@SafeVarargs
public static ConfigurationData createConfiguration(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

public static ConfigurationData createConfiguration(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

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

createConfiguration

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

collectData

protected ConfigurationData collectData(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(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(Field field,
                                          String path)

getPropertyField

@Nullable
protected Property<?> getPropertyField(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

collectSectionComments

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

createSettingsHolderInstance

protected <T extends SettingsHolder> T createSettingsHolderInstance(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