Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thegatesdev/maple
A clean, type safe intermediary structure
https://github.com/thegatesdev/maple
config configuration configuration-files data-structures json yaml
Last synced: 14 days ago
JSON representation
A clean, type safe intermediary structure
- Host: GitHub
- URL: https://github.com/thegatesdev/maple
- Owner: thegatesdev
- License: apache-2.0
- Created: 2022-07-13T10:14:37.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-11T09:25:48.000Z (6 months ago)
- Last Synced: 2024-07-11T10:54:58.629Z (6 months ago)
- Topics: config, configuration, configuration-files, data-structures, json, yaml
- Language: Java
- Homepage:
- Size: 1.22 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
*This is a **WIP version** of this document for the upcoming v5.0.0 release.*
[](#)
[](#)
[](https://www.codefactor.io/repository/github/thegatesdev/maple)
[](https://github.com/thegatesdev/maple/commits/main/)
[](https://github.com/thegatesdev/maple/releases)
[](https://github.com/thegatesdev/maple/releases)
A clean, type safe intermediary structure in Java
*Updated for version 5.0.0*
*TODO: Add inspiration section*
*TODO: Split into 'Usage' and 'About' sections*
## Inspiration
## About
*TODO: get to the point faster, save trivia for some other place*
**Maple** was originally intended as a replacement to the Spigot Configuration API,
which allows Minecraft plugins to read data from configuration files.
This is still my use-case for this library, but the goals have grown way past that.
My goal with this library is to represent JSON like configuration values
in a clean and understandable structure, with plenty of utilities for different scenario's,
while taking inspiration from (and possibly improving upon) existing libraries.
Feel free to open an issue or submit a pull request if you have any concerns or suggestions.
## Including in your project
*TODO: Show maven and gradle include examples*
**Maple** is public on GitHub, meaning you can easily get it from JitPack.
Head to https://jitpack.io/#thegatesdev/maple,
select a version and follow the instructions for your build system.
Now you are ready to dive in!
## Setting some rules
Here are some rules to keep in mind while using **Maple**:
- **`null` is not invited to the party.**
This library does not allow `null` values passed in, and guarantees that no `null` will ever be returned.
- **Non-exported packages are unsafe.**
The `module-info.java` defines the packages that are exported.
If you are not using the Java module system, it is still not recommended
to use the classes in the packages that are not exported.
These packages are considered outside the public facing API and can change without warning.
## Creating elements
*TODO: Look for alternatives to saying 'you can'*
You can directly create elements of primitive types...
```java
Element intElement = Element.of(30);
Element boolElement = Element.of(true);
Element stringElement = Element.of("foo");
```
For constructing lists and dictionaries, use the corresponding builders...
```java
ListElement listElement = ListElement.builder()
.add(Element.of(30))
.add(Element.of(true))
.add(Element.of("foo"))
.build();
DictElement dictElement = DictElement.builder()
.put("int", Element.of(30))
.put("bool", Element.of(true))
.put("string", Element.of("foo"))
.build();
```
Merging dictionaries can also be done using builders...
```java
DictElement original;
DictElement other;
DictElement merged = original.toBuilder()
.putAll(other)
.build();
```
## Getting values from elements
*TODO: Needs smaller examples*
Obtaining values has never looked nicer...
```java
DictElement dictElement; // assuming the dictionary from the above example
dictElement.get("int").isNumber(); // true
boolean boolValue = dictElement.get("bool").getBool(); // true
boolean invalidBoolValue = dictElement.get("string").getBool(); // throws ElementTypeException
Optional notPresent = dictElement.find("not_present"); // empty optional
```
## Goals
**Maple** is definitely not finished. Here are some of the features I'd like to implement in the future:
- Implement parsing for at least JSON and YAML files. Some would call this essential.
- Better API for user feedback, like getting the path of an element.
- Object mapping.
- Saving and loading API, possibly with live update.
## The end
Thank you for reading, and have a nice day!
You can find me on Discord under the tag `thegatesdev`.