ch.jalu.configme

Class SettingsManagerBuilder

java.lang.Object

ch.jalu.configme.SettingsManagerBuilder

public final class SettingsManagerBuilder
extends Object

Creates SettingsManager instances.

Method Summary

Modifier and Type	Method and Description
SettingsManagerBuilder	configurationData(Class<? extends SettingsHolder>... classes) Sets up configuration data with the input of the given settings holder classes.
SettingsManagerBuilder	configurationData(ConfigurationData configurationData) Sets the provided configuration data to the builder.
SettingsManager	create() Creates a settings manager instance.
SettingsManagerBuilder	migrationService(MigrationService migrationService) Sets the given migration service to the builder.
SettingsManagerBuilder	useDefaultMigrationService() Registers the default migration service to the builder, which triggers a rewrite of the configuration file if a property is missing from it.
static SettingsManagerBuilder	withResource(PropertyResource resource) Creates a new builder with the given property resource.
static SettingsManagerBuilder	withYamlFile(File file) Creates a builder, using the given YAML file to use as property resource.

Methods inherited from class java.lang.Object

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

Method Detail

withYamlFile

public static SettingsManagerBuilder withYamlFile(File file)

Creates a builder, using the given YAML file to use as property resource.

Parameters:

file - the yaml file to use

Returns:

settings manager builder

withResource

public static SettingsManagerBuilder withResource(PropertyResource resource)

Creates a new builder with the given property resource.

Parameters:

resource - the resource to use

Returns:

settings manager builder

configurationData

@SafeVarargs
public final SettingsManagerBuilder configurationData(Class<? extends SettingsHolder>... classes)

Sets up configuration data with the input of the given settings holder classes.

Parameters:

classes - the settings holder classes

Returns:

this builder

configurationData

public SettingsManagerBuilder configurationData(ConfigurationData configurationData)

Sets the provided configuration data to the builder.

Parameters:

configurationData - the configuration data

Returns:

this builder

migrationService

public SettingsManagerBuilder migrationService(@Nullable
                                               MigrationService migrationService)

Sets the given migration service to the builder.

Parameters:

migrationService - the migration service to use (or null)

Returns:

this builder

useDefaultMigrationService

public SettingsManagerBuilder useDefaultMigrationService()

Registers the default migration service to the builder, which triggers a rewrite of the configuration file if a property is missing from it.

Returns:

this builder

create

public SettingsManager create()

Creates a settings manager instance. It is mandatory that resource and configuration data have been configured beforehand.

Returns:

the settings manager