info.u_team.u_team_core.util

Class ConfigUtil

java.lang.Object

info.u_team.u_team_core.util.ConfigUtil

public class ConfigUtil
extends java.lang.Object

Load and read json config files with gson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JSON_EXTENSION Default extension of json files

Constructor Summary

Constructors

Constructor and Description
ConfigUtil()

Method Summary

Modifier and Type	Method and Description
static <T> T	loadConfig(java.nio.file.Path directory, java.lang.String name, com.google.gson.Gson gson, java.util.function.Function<com.google.gson.stream.JsonWriter,T> write, java.util.function.Function<java.io.BufferedReader,T> read) Load and create a config file if not already there from a default value.
static <T> T	loadConfig(java.nio.file.Path directory, java.lang.String name, com.google.gson.Gson gson, T defaultValue, java.util.function.BiConsumer<com.google.gson.stream.JsonWriter,T> write, java.util.function.Function<java.io.BufferedReader,T> read) Load and create a config file if not already there from a default value.
static <T> T	loadConfig(java.nio.file.Path directory, java.lang.String name, java.lang.String extension, com.google.gson.Gson gson, java.util.function.Function<com.google.gson.stream.JsonWriter,T> write, java.util.function.Function<java.io.BufferedReader,T> read) Load and create a config file if not already there from a default value.
static <T> T	loadConfig(java.nio.file.Path directory, java.lang.String name, java.lang.String extension, com.google.gson.Gson gson, T defaultValue, java.util.function.BiConsumer<com.google.gson.stream.JsonWriter,T> write, java.util.function.Function<java.io.BufferedReader,T> read) Load and create a config file if not already there from a default value.

Methods inherited from class java.lang.Object

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

Field Detail

JSON_EXTENSION

public static final java.lang.String JSON_EXTENSION

Default extension of json files

See Also:

Constant Field Values

Constructor Detail

ConfigUtil

public ConfigUtil()

Method Detail

loadConfig

public static <T> T loadConfig(java.nio.file.Path directory,
                               java.lang.String name,
                               com.google.gson.Gson gson,
                               java.util.function.Function<com.google.gson.stream.JsonWriter,T> write,
                               java.util.function.Function<java.io.BufferedReader,T> read)
                        throws java.io.IOException

Load and create a config file if not already there from a default value. Use Gson for serialization and deserialization. The extension of the file is automatically JSON_EXTENSION

Type Parameters:

T - Class to load with gson

Parameters:

directory - Path of the directory where the file is

name - The file without the extension

gson - Gson instance with possible registered serializer

write - Function that should write the default values to the JsonWriter and return the the default instance

read - Function that should read the values from BufferedReader and deserialize them and return a new instance of the class with the new values

Returns:

Either the default instance if the file was created or an instance with loaded value from the config

Throws:

java.io.IOException

loadConfig

public static <T> T loadConfig(java.nio.file.Path directory,
                               java.lang.String name,
                               java.lang.String extension,
                               com.google.gson.Gson gson,
                               java.util.function.Function<com.google.gson.stream.JsonWriter,T> write,
                               java.util.function.Function<java.io.BufferedReader,T> read)
                        throws java.io.IOException

Load and create a config file if not already there from a default value. Use Gson for serialization and deserialization.

Type Parameters:

T - Class to load with gson

Parameters:

directory - Path of the directory where the file is

name - The file without the extension

extension - Extension of the file

gson - Gson instance with possible registered serializer

write - Function that should write the default values to the JsonWriter and return the the default instance

read - Function that should read the values from BufferedReader and deserialize them and return a new instance of the class with the new values

Returns:

Either the default instance if the file was created or an instance with loaded value from the config

Throws:

java.io.IOException

loadConfig

public static <T> T loadConfig(java.nio.file.Path directory,
                               java.lang.String name,
                               com.google.gson.Gson gson,
                               T defaultValue,
                               java.util.function.BiConsumer<com.google.gson.stream.JsonWriter,T> write,
                               java.util.function.Function<java.io.BufferedReader,T> read)
                        throws java.io.IOException

Load and create a config file if not already there from a default value. Use Gson for serialization and deserialization. The extension of the file is automatically JSON_EXTENSION

Type Parameters:

T - Class to load with gson

Parameters:

directory - Path of the directory where the file is

name - The file without the extension

gson - Gson instance with possible registered serializer

defaultValue - The default instance of the class that should be written if no config file is present

write - BiConsumer that should write the default values to the JsonWriter

read - Function that should read the values from BufferedReader and deserialize them and return a new instance of the class with the new values

Returns:

Either the default instance if the file was created or an instance with loaded value from the config

Throws:

java.io.IOException

loadConfig

public static <T> T loadConfig(java.nio.file.Path directory,
                               java.lang.String name,
                               java.lang.String extension,
                               com.google.gson.Gson gson,
                               T defaultValue,
                               java.util.function.BiConsumer<com.google.gson.stream.JsonWriter,T> write,
                               java.util.function.Function<java.io.BufferedReader,T> read)
                        throws java.io.IOException

Load and create a config file if not already there from a default value. Use Gson for serialization and deserialization.

Type Parameters:

T - Class to load with gson

Parameters:

directory - Path of the directory where the file is

name - The file without the extension

extension - Extension of the file

gson - Gson instance with possible registered serializer

defaultValue - The default instance of the class that should be written if no config file is present

write - BiConsumer that should write the default values to the JsonWriter

read - Function that should read the values from BufferedReader and deserialize them and return a new instance of the class with the new values

Returns:

Either the default instance if the file was created or an instance with loaded value from the config

Throws:

java.io.IOException