Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Maven central coordinates #14

Merged
merged 1 commit into from
Oct 9, 2023
Merged

Maven central coordinates #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 35 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,19 @@ A parser for [TOML](https://toml.io/en/) files with minimum dependencies.
1. To return a Java object tree with no custom classes.
1. To have as little runtime dependencies as possible (currently only Antlr4 runtime is required).

## Type mapping

The java object tree generated after parsing a TOML document is created with the following Java types:
## Maven & Gradle coordinates

```xml
<dependency>
<groupId>net.vieiro</groupId>
<artifactId>toml-java</artifactId>
<version>1.1.1</version>
</dependency>
```

| TOML Type | Java Type |
|-----------|-----------|
| Integer | Long |
| Boolean | Boolean |
| Float | Double (including PositiveInfinity, NegativeInfinity or NaN) |
| String | String |
| Offset date-time | OffsetDateTime |
| Local date-time | LocalDateTime |
| Local date | LocalDate |
| Local time | LocalTime |
| Array | List&lt;Object&gt; |
| Table | Map&lt;String, Object&gt; |
| Array of Tables | List&lt;Map&lt;String, Object&gt;&gt; |
```
implementation 'net.vieiro:toml-java:1.1.1'
```

## Basic usage

Expand All @@ -46,16 +42,35 @@ A basic parsing of a TOML document would be:
TOML toml = TOMLParser.parseFromInputStream(input);

// No errors should be produced
assert(toml.getErrors().isEmpty())
assert(toml.getErrors().isEmpty());

// Obtain the parsed object tree
Map<Object, Object> parsed = toml.getRoot();
Map<String, Object> parsed = toml.getRoot();

// Obtain the syntax errors, if any
List<String> errors = toml.getErrors();
// Or query the parsed object tree
String red = toml.getString("fruits/0/physical/color").orElse(null);

```


## Type mapping

The java object tree generated after parsing a TOML document is created with the following Java types:

| TOML Type | Java Type |
|-----------|-----------|
| Integer | Long |
| Boolean | Boolean |
| Float | Double (including PositiveInfinity, NegativeInfinity or NaN) |
| String | String |
| Offset date-time | OffsetDateTime |
| Local date-time | LocalDateTime |
| Local date | LocalDate |
| Local time | LocalTime |
| Array | List&lt;Object&gt; |
| Table | Map&lt;String, Object&gt; |
| Array of Tables | List&lt;Map&lt;String, Object&gt;&gt; |

### Javadoc API

See [the Javadoc for this project](https://vieiro.github.io/toml-java/javadoc/) for more details.
Expand Down