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
@NotNull SettingsManagerBuilder	configurationData(Class<? extends SettingsHolder>... classes) Sets up configuration data with the input of the given settings holder classes.
@NotNull SettingsManagerBuilder	configurationData(@NotNull ConfigurationData configurationData) Sets the provided configuration data to the builder.
@NotNull SettingsManager	create() Creates a settings manager instance.
@NotNull SettingsManagerBuilder	migrationService(@Nullable MigrationService migrationService) Sets the given migration service to the builder.
@NotNull 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 @NotNull SettingsManagerBuilder	withResource(@NotNull PropertyResource resource) Creates a new builder with the given property resource.
static @NotNull SettingsManagerBuilder	withYamlFile(@NotNull File file) Creates a builder, using the given YAML file to use as property resource.
static @NotNull SettingsManagerBuilder	withYamlFile(@NotNull File file, @NotNull YamlFileResourceOptions resourceOptions) Creates a builder, using the given YAML file to use as property resource with the given options.
static @NotNull SettingsManagerBuilder	withYamlFile(@NotNull Path file) Creates a builder, using the given YAML file to use as property resource.
static @NotNull SettingsManagerBuilder	withYamlFile(@NotNull Path path, @NotNull YamlFileResourceOptions resourceOptions) Creates a builder, using the given YAML file to use as property resource with the given options.

Methods inherited from class java.lang.Object

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

Method Detail

withYamlFile

@NotNull
public static @NotNull SettingsManagerBuilder withYamlFile(@NotNull
                                                                    @NotNull Path 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

withYamlFile

@NotNull
public static @NotNull SettingsManagerBuilder withYamlFile(@NotNull
                                                                    @NotNull 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

withYamlFile

@NotNull
public static @NotNull SettingsManagerBuilder withYamlFile(@NotNull
                                                                    @NotNull Path path,
                                                                    @NotNull
                                                                    @NotNull YamlFileResourceOptions resourceOptions)

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

Parameters:

path - the yaml file to use

resourceOptions - the resource options

Returns:

settings manager builder

withYamlFile

@NotNull
public static @NotNull SettingsManagerBuilder withYamlFile(@NotNull
                                                                    @NotNull File file,
                                                                    @NotNull
                                                                    @NotNull YamlFileResourceOptions resourceOptions)

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

Parameters:

file - the yaml file to use

resourceOptions - the resource options

Returns:

settings manager builder

withResource

@NotNull
public static @NotNull SettingsManagerBuilder withResource(@NotNull
                                                                    @NotNull PropertyResource resource)

Creates a new builder with the given property resource.

Parameters:

resource - the resource to use

Returns:

settings manager builder

configurationData

@SafeVarargs
 @NotNull
public final @NotNull SettingsManagerBuilder configurationData(@NotNull
                                                                                      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

@NotNull
public @NotNull SettingsManagerBuilder configurationData(@NotNull
                                                                  @NotNull ConfigurationData configurationData)

Sets the provided configuration data to the builder.

Parameters:

configurationData - the configuration data

Returns:

this builder

migrationService

@NotNull
public @NotNull SettingsManagerBuilder migrationService(@Nullable
                                                                 @Nullable MigrationService migrationService)

Sets the given migration service to the builder.

Parameters:

migrationService - the migration service to use (or null)

Returns:

this builder

useDefaultMigrationService

@NotNull
public @NotNull 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

@NotNull
public @NotNull SettingsManager create()

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

Returns:

the settings manager