net.lenni0451.optconfig.provider

Interface ConfigProvider

All Known Implementing Classes:

MemoryConfigProvider, PathConfigProvider

public interface ConfigProvider

A provider to load and save the config content.

Method Summary

Modifier and Type	Method and Description
boolean	exists()
static PathConfigProvider	file(java.io.File file) Create a new PathConfigProvider with the given file.
java.lang.String	load() Load the content of the config file.
static MemoryConfigProvider	memory(java.lang.String content, java.util.function.Consumer<java.lang.String> contentConsumer) Create a new MemoryConfigProvider with the given content and consumer.
static MemoryConfigProvider	memory(java.util.function.Supplier<java.lang.String> contentSupplier, java.util.function.Consumer<java.lang.String> contentConsumer) Create a new MemoryConfigProvider with the given content supplier and consumer.
static PathConfigProvider	path(java.nio.file.Path path) Create a new PathConfigProvider with the given path.
void	save(java.lang.String content) Save the content to the config file.

Method Detail

file

static PathConfigProvider file(java.io.File file)

Create a new PathConfigProvider with the given file.

Parameters:

file - The file to the config file

Returns:

The created PathConfigProvider

path

static PathConfigProvider path(java.nio.file.Path path)

Create a new PathConfigProvider with the given path.

Parameters:

path - The path to the config file

Returns:

The created PathConfigProvider

memory

static MemoryConfigProvider memory(java.lang.String content,
                                   java.util.function.Consumer<java.lang.String> contentConsumer)

Create a new MemoryConfigProvider with the given content and consumer.

Parameters:

content - The content of the config file

contentConsumer - The consumer to set the content

Returns:

The created MemoryConfigProvider

memory

static MemoryConfigProvider memory(java.util.function.Supplier<java.lang.String> contentSupplier,
                                   java.util.function.Consumer<java.lang.String> contentConsumer)

Create a new MemoryConfigProvider with the given content supplier and consumer.

Parameters:

contentSupplier - The supplier to get the content

contentConsumer - The consumer to set the content

Returns:

The created MemoryConfigProvider

load

java.lang.String load()
               throws java.io.IOException

Load the content of the config file.
This method may be called multiple times.

Returns:

The content of the config file

Throws:

java.io.IOException - If an I/O error occurs

save

void save(java.lang.String content)
   throws java.io.IOException

Save the content to the config file.

Parameters:

content - The content to save

Throws:

java.io.IOException - If an I/O error occurs

exists

boolean exists()

Returns:

If a config already exists