https://github.com/alcatrazescapee/epsilon

A config library which is at least > 0.
https://github.com/alcatrazescapee/epsilon

Last synced: 3 days ago
JSON representation

A config library which is at least > 0.

• Host: GitHub
• URL: https://github.com/alcatrazescapee/epsilon
• Owner: alcatrazEscapee
• License: mit
• Created: 2022-10-17T00:15:28.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-08-07T01:32:39.000Z (over 1 year ago)
• Last Synced: 2024-11-08T21:43:45.278Z (about 1 month ago)
• Language: Java
• Homepage:
• Size: 104 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Epsilon

This is a minimal library for handling simple configuration files. It was designed with a few key principles in mind:

- Config files should be in an easy-to-read, easy-to-write, and simple language. A custom subset of the [Toml](https://github.com/toml-lang/toml) language was chosen for this purpose.

- Configuration options should be specified using a simple builder-style API, and allow default values, comments, and custom types.

- File reading should happen once, on an explicit invocation of `EpsilonUtil.parse()`.

- Accessing configuration options should be as simple and as performant as possible, once the configuration file has been loaded, performing no automatic unboxing (i.e. `Integer` -> `int`), no required casts (i.e. `double` -> `float`), or complex operations such as map lookups or string comparisons, and suitable for high performance code paths.

### Usage

Include this project via gradle:

```groovy

repositories {

    maven {

        url = "https://alcatrazescapee.com/maven"

    }

}

dependencies {

    implementation "com.alcatrazescapee:epsilon:0.6"

}

```

An example usage of the library can be found below:

```java

import com.alcatrazescapee.epsilon.*;

import com.alcatrazescapee.epsilon.value.*;

// Define a spec, which is a representation of all config options, comments, and value restrictions.

final SpecBuilder builder = Spec.builder();

// builder.define() can be invoked with int, boolean, float, String, or List types.

// The returned value, i.e. IntValue, is later used to access the value of the config option.

final IntValue intValue = builder.comment("An example integer value").define("intValue", 5);

// push() and pop() groups config options into categories.

// comment() can be used to add comments directly to categories

builder.push("category");

// This value is grouped under the category 'category'

final BoolValue boolValue = builder.define("boolValue", false);

builder.pop();

final Spec spec = builder.build();

// When desired, parse the config file

// The LOGGER::warn is used to record errors either during parsing, or invalid config values

EpsilonUtil.parse(spec, Path.of("config-file.toml"), LOGGER::warn);

// Access of the config values can be done at any time after that.

final int value = intValue.getAsInt();

final boolean bool = boolValue.getAsBoolean();

```