/
README.in
38 lines (27 loc) · 1.01 KB
/
README.in
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
## anethum
A common API for parsers and serializers in [io7m](https://www.io7m.com)
packages.
### Features
* Standardized interface for parsers.
* Standardized interface for serializers.
* Parse errors are [structured errors](https://www.io7m.com/software/seltzer).
* Written in pure Java 17.
* [OSGi](https://www.osgi.org/) ready.
* [JPMS](https://en.wikipedia.org/wiki/Java_Platform_Module_System) ready.
* ISC license.
* High-coverage automated test suite.
### Motivation
[io7m](https://www.io7m.com) packages expose many different parsers and
serializers. The `anethum` package attempts to define a consistent and
strongly-typed API specification that these parsers and serializers can
implement in order to provide a uniform user experience between all of the
different packages.
### Building
```
$ mvn clean verify
```
### Usage
Parsers should implement the `ParserFactoryType` and `ParserType`
interfaces.
Serializers should implement the `SerializerFactoryType` and `SerializerType`
interfaces.