anethum
A common API for parsers and serializers in io7m packages.
Features
- Standardized interface for parsers.
- Standardized interface for serializers.
- Parse errors are structured errors.
- Written in pure Java 17.
- OSGi ready.
- JPMS ready.
- ISC license.
- High-coverage automated test suite.
Motivation
io7m 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.
Releases & Development Snapshots
Releases
You can subscribe to the atom feed to be notified of project releases.
The most recently released version of the package is 1.1.1.
1.1.1 Release (2024-05-10Z)
- Update org.slf4j:slf4j-api:2.0.10 → 2.0.13.
- Update ch.qos.logback:logback-classic:1.4.14 → 1.5.6.
- Update junit.version:5.10.1 → 5.10.2.
- Update jqwik.version:1.8.2 → 1.8.4.
- Update com.io7m.jlexing:com.io7m.jlexing.core:3.1.0 → 3.2.0.
- Update com.io7m.seltzer:com.io7m.seltzer.api:1.0.0 → 1.0.1.
- Move to new organization.
The compiled artifacts for the release (and all previous releases) are available on Maven Central.
Maven Modules
<dependency> <group>com.io7m.anethum</group> <artifactId>com.io7m.anethum.api</artifactId> <version>1.1.1</version> </dependency><dependency> <group>com.io7m.anethum</group> <artifactId>com.io7m.anethum.slf4j</artifactId> <version>1.1.1</version> </dependency><dependency> <group>com.io7m.anethum</group> <artifactId>com.io7m.anethum.tests</artifactId> <version>1.1.1</version> </dependency>
Previous Releases
The changelogs for the most recent previous releases are as follows:
1.1.0 Release (2023-08-13Z)
- Add com.io7m.anethum.slf4j module for convenient logging.
1.0.0 Release (2023-06-11Z)
- Initial major release.
Development Snapshots
At the time of writing, the current unstable development version of the package is 1.1.2-SNAPSHOT.
Development snapshots may be available in the Central Portal Snapshots repository. Snapshots are published to this repository every time the project is built by the project's continuous integration system, but snapshots do expire after around ninety days and so may or may not be available depending on when a build of the package was last triggered.
Manual
This project does not have any user manuals or other documentation beyond what might be present on the page above.
Sources
This project uses Git to manage source code.
Repository: https://www.github.com/io7m-com/anethum
$ git clone --recursive https://www.github.com/io7m-com/anethum
Issues
This project uses GitHub Issues to track issues.
License
Copyright © 2023 Mark Raynsford <code@io7m.com> https://www.io7m.com Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.