Project icon

com.io7m.jpra

Build status Maven Central Codacy Codecov

The jpra package implements a system for efficiently accessing packed record values. It provides a simple schema language for defining types and can produce efficient "flyweight" ByteBuffer-backed record types in Java.

Contents

Features

  • Generate ByteBuffer-backed record types in Java, using a cursor abstraction for allocation-free access to large off-heap arrays.
  • Simple command-line frontend for checking schemas and producing Java sources.
  • Maven plugin for producing Java sources during Maven builds.
  • ISC license.

Releases

The current release is 0.7.0-SNAPSHOT.

Source code and binaries are available from the repository.

Documentation

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

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

User Documentation

Language Specification

Maven

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

<dependency>
  <groupId>com.io7m.jpra</groupId>
  <artifactId>com.io7m.jpra</artifactId>
  <version>0.7.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jpra</groupId>
  <artifactId>com.io7m.jpra.compiler.core</artifactId>
  <version>0.7.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jpra</groupId>
  <artifactId>com.io7m.jpra.compiler.frontend</artifactId>
  <version>0.7.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jpra</groupId>
  <artifactId>com.io7m.jpra.compiler.java</artifactId>
  <version>0.7.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jpra</groupId>
  <artifactId>com.io7m.jpra.core</artifactId>
  <version>0.7.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jpra</groupId>
  <artifactId>com.io7m.jpra.documentation</artifactId>
  <version>0.7.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jpra</groupId>
  <artifactId>com.io7m.jpra.maven.plugin</artifactId>
  <version>0.7.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jpra</groupId>
  <artifactId>com.io7m.jpra.model</artifactId>
  <version>0.7.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jpra</groupId>
  <artifactId>com.io7m.jpra.runtime.java</artifactId>
  <version>0.7.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jpra</groupId>
  <artifactId>com.io7m.jpra.specification</artifactId>
  <version>0.7.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jpra</groupId>
  <artifactId>com.io7m.jpra.tests</artifactId>
  <version>0.7.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-11-16 Release: com.io7m.jpra 0.7.0
2017-11-16 Change: (Backwards incompatible) All modules are now Java 9 modules. JDK 9 is now required.
2017-11-16 Change: (Backwards incompatible) Removed dependency on com.io7m.jnull.
2017-11-16 Change: (Backwards incompatible) Replace gs-collections with Vavr (tickets: 25 )
2017-11-16 Change: (Backwards incompatible) Replace airline with jcommander (tickets: 9 )
2017-11-16 Change: (Backwards incompatible) Replace commons-lang3 with commons-text (tickets: 26 )
2017-11-16 Change: Allow packed fields to be 1 bit (tickets: 23 )
2017-04-03 Release: com.io7m.jpra 0.6.0
2017-04-03 Change: (Backwards incompatible) Use primogenitor, renaming all modules to the new OSGi conventions.
2017-04-07 Change: (Backwards incompatible) Use new core io7m packages. Eliminate valid4j. (tickets: 24 21 )
2016-08-05 Release: com.io7m.jpra 0.5.0
2016-08-05 Change: Update Maven plugins
2016-08-05 Change: (Backwards incompatible) Update to latest version of all dependencies (changes API)
2016-08-05 Change: The runtime jar is now an OSGi bundle
2016-01-17 Release: com.io7m.jpra 0.4.1
2016-01-17 Change: Fix bit/byte ordering of packed types (tickets: 19 )
2015-12-11 Release: com.io7m.jpra 0.4.0
2015-12-11 Change: Add static size and offset methods to generated types (tickets: 18 )
2015-12-11 Change: Reduce size of jpra-c frontend jar (tickets: 14 )
2015-12-06 Release: com.io7m.jpra 0.3.2
2015-12-06 Change: Specification clarifications and improvements (tickets: 13 12 11 )
2015-12-06 Change: Correct JavaDoc for packed 'set' methods (tickets: 16 15 )
2015-12-04 Change: Use immutables 2.1.2
2015-12-04 Release: com.io7m.jpra 0.3.1
2015-12-04 Change: Minor fixes for metadata and site
2015-11-24 Release: com.io7m.jpra 0.3.0
2015-11-24 Change: Expose type metadata at run-time (tickets: 10 )
2015-11-21 Release: com.io7m.jpra 0.2.1
2015-11-21 Change: Correct API documentation links
2015-11-21 Release: com.io7m.jpra 0.2.0
2015-11-21 Change: Implement more of the language (tickets: 2 6 7 )
2015-11-16 Release: com.io7m.jpra 0.1.0
2015-11-16 Change: Initial release.

Sources

This project uses Git to manage source code.

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

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

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.