Project icon

com.io7m.jserial

Build status Maven Central Codacy Codecov

The jserial package is an implementation of serial number arithmetic.

The package implements the improved algorithm published by Perry Kundert.

Contents

Features

  • 8-bit serial number arithmetic
  • 16-bit serial number arithmetic
  • 24-bit serial number arithmetic
  • 32-bit serial number arithmetic
  • 40-bit serial number arithmetic
  • 48-bit serial number arithmetic
  • 56-bit serial number arithmetic
  • 62-bit serial number arithmetic
  • High coverage test suite
  • OSGi-ready
  • JPMS-ready
  • ISC license

Releases

The current release is 0.5.0-SNAPSHOT.

Source code and binaries are available from the repository.

Documentation

Documentation for the 0.5.0-SNAPSHOT release is available for reading online.

Documentation for current and older releases is archived in the repository.

User documentation

Maven

The following is a complete list of the project's modules expressed as Maven dependencies:

<dependency>
  <groupId>com.io7m.jserial</groupId>
  <artifactId>com.io7m.jserial</artifactId>
  <version>0.5.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jserial</groupId>
  <artifactId>com.io7m.jserial.core</artifactId>
  <version>0.5.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jserial</groupId>
  <artifactId>com.io7m.jserial.documentation</artifactId>
  <version>0.5.0-SNAPSHOT</version>
</dependency>

Each release of the project is made available on Maven Central within ten minutes of the release announcement.

Changes

Subscribe to the releases atom feed.

2017-08-09 Release: com.io7m.jserial 0.4.0
2017-08-08 Change: Correct value wrapping: Distance comparisons were incorrect near the upper bounds of ranges.
2017-08-09 Change: Add unsigned distance functions.
2017-11-05 Change: (Backwards incompatible) Require JDK 9, publish Java 9 modules.
2017-11-05 Change: (Backwards incompatible) Remove com.io7m.jnull dependency.
2017-04-16 Release: com.io7m.jserial 0.3.0
2016-06-16 Change: (Backwards incompatible) Complete rewrite. Use interfaces and provide specialized 8, 16, 24, 32, 40, 48, 56, and 62 bit variants.
2016-06-16 Change: (Backwards incompatible) Require JDK 8 for unsigned functionality.
2017-04-16 Change: (Backwards incompatible) Rename project. Use the new primogenitor POM and 2017 project conventions.
2016-06-09 Release: com.io7m.jserial 0.1.0
2016-06-09 Change: Initial release.

Sources

This project uses Git to manage source code.

Repository: https://github.com/io7m/jserial

$ git clone https://github.com/io7m/jserial

License

Copyright ⓒ 2018 Mark Raynsford <code@io7m.com> http://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.

Bug Tracker

The project uses GitHub Issues to track issues.