https://github.com/pixelguys/trivialjson
A json parser designed to trivially read config files
https://github.com/pixelguys/trivialjson
Last synced: 4 months ago
JSON representation
A json parser designed to trivially read config files
- Host: GitHub
- URL: https://github.com/pixelguys/trivialjson
- Owner: PixelGuys
- License: unlicense
- Created: 2022-03-01T22:12:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-03T13:43:20.000Z (about 4 years ago)
- Last Synced: 2024-12-31T07:24:50.741Z (over 1 year ago)
- Language: Java
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TrivialJson
## Goals
Most json libraries out there (at least the ones I've seen) are complicated to use.\
Especially for parsing config files, it can be quite tedious having to check for every single value if it exists.
So I wanted to make an easy to use json library that avoids all those checks, while still being safe from errors.\
For that I'm requiring default values that are returned if the key isn't found.
Additionally I wanted to have support for hexadecimal numbers (e.g. `0xff008b`).\
This obviously means that the parser uses a super-set of json.
The parser is also quite forgiving when it comes to smaller errors, such as missing or additional `,`.
## Example
#### Creating json
```java
JsonObject ore = new JsonObject();
ore.put("veins", 7.5);
ore.put("size", 9);
ore.put("height", 68);
ore.put("density", 0.1f);
JsonArray oreSources = new JsonArray();
oreSources.addStrings("cubyz:stone", "cubyz:soil");
ore.put("sources", oreSources);
System.out.println(json.toString());
// {"veins":7.5,"size":9,"height":68,"density":0.1,"source":["cubyz:stone", "cubyz:soil"]}
```
#### Reading json
```java
JsonObject json = JsonParser.parseObjectFromFile("path/to/file");
breakingPower = json.getFloat("breakingPower", 0);
hardness = json.getFloat("hardness", 1);
blockClass = BlockClass.valueOf(json.getString("class", "STONE").toUpperCase());
light = json.getInt("emittedLight", 0);
absorption = json.getInt("absorbedLight", 0);
lightingTransparent = json.has("absorbedLight");
// No matter what's inside of path/to/file, there will be no exception thrown here, but there will be error messages.
```
#### Changing the error output
When the parser encounters errors, it will print an error message. But it will keep parsing, trying to get some output rather than none.
```java
Json.setErrorHandler((error) -> Logger.warning(error));
// On default the error gets output to System.out.println().
```
## Usage
#### maven
Add this to your `pom.xml` file:
```xml
... (other repositories)
cubyz
https://raw.githubusercontent.com/PixelGuys/Cubyz-Dependencies/master/
cubyz
...
pixelguys.json
trivial-json
1.1
```
#### other
Get the jar file from the release section.