Project icon

com.io7m.jregions

Build status Maven Central Codecov

The jregions package provides a set of immutable area types.

Contents

Features

  • Extensive set of functions for scaling, aligning, moving boxes.
  • High coverage test suite.
  • Written in pure Java 21.
  • OSGi-ready.
  • JPMS-ready.
  • ISC license.

Releases

The most recently published version of the software is 5.0.0.

Source code and binaries are available from the repository.

Documentation

Documentation for the 5.0.0 release is available for reading online.

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

User documentation

See the README.

Maven

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

<dependency>
  <groupId>com.io7m.jregions</groupId>
  <artifactId>com.io7m.jregions</artifactId>
  <version>5.0.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.jregions</groupId>
  <artifactId>com.io7m.jregions.arbitraries</artifactId>
  <version>5.0.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.jregions</groupId>
  <artifactId>com.io7m.jregions.core</artifactId>
  <version>5.0.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.jregions</groupId>
  <artifactId>com.io7m.jregions.tests</artifactId>
  <version>5.0.0</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.

2024-05-13 Release: com.io7m.jregions 5.0.0
2024-04-19 Change: Update nl.jqno.equalsverifier:equalsverifier:3.15.5 → 3.16.1.
2024-04-19 Change: Update org.immutables:value:2.10.0 → 2.10.1.
2024-04-19 Change: Update ch.qos.logback:logback-classic:1.4.14 → 1.5.6.
2024-04-20 Change: Update junit.version:5.10.1 → 5.10.2.
2024-04-22 Change: Update org.slf4j:slf4j-api:2.0.10 → 2.0.13.
2024-05-05 Change: Update com.io7m.jaffirm:com.io7m.jaffirm.core:4.0.0 → 4.0.1.
2024-05-12 Change: (Backwards incompatible) Remove com.io7m.jregions.generators module.
2024-05-12 Change: Add new com.io7m.jregions.arbitraries module.
2024-05-13 Change: (Backwards incompatible) Require JDK 21.
2022-04-09 Release: com.io7m.jregions 4.0.0
2022-04-09 Change: (Backwards incompatible) Require JDK 17
2022-04-09 Release: com.io7m.jregions 3.0.0
2021-01-11 Change: Add moveRelativeClamped (tickets: 16 )
2021-01-15 Change: Upgrade to Junit 5 (tickets: 18 )
2017-12-07 Release: com.io7m.jregions 2.0.0
2017-12-07 Change: (Backwards incompatible) Removed dependency on com.io7m.jnull
2017-12-07 Change: (Backwards incompatible) All modules are now Java 9 modules. JDK 9 is now required.
2017-05-06 Release: com.io7m.jregions 1.1.0
2017-05-06 Change: Add splitAlongXY method for dividing areas into quadrants.
2017-05-07 Change: Stop using terms such as "horizontally", "vertically", "width", "height", etc. Deprecate methods and add replacements. (tickets: 11 )
2017-05-06 Change: Add volume types. (tickets: 9 )
2017-05-08 Change: Fix overlaps() for areas and volumes. (tickets: 12 14 )
2017-05-08 Change: Fix contains() for areas and volumes. (tickets: 13 )
2017-04-16 Release: com.io7m.jregions 1.0.0
2017-04-16 Change: Initial public API release.
2017-04-09 Release: com.io7m.jregions 0.0.6
2017-04-09 Change: Add convenient methods to construct areas from sizes. (tickets: 8 )
2017-04-08 Release: com.io7m.jregions 0.0.5
2017-04-08 Change: Use primogenitor 1.0.2. Use newest versions of core io7m libraries.
2017-03-13 Release: com.io7m.jregions 0.0.4
2017-03-13 Change: Use primogenitor 0.0.7.
2017-03-09 Release: com.io7m.jregions 0.0.3
2017-03-08 Change: Add common "value" interfaces. (tickets: 1 )
2017-03-08 Change: Add missing float and BigDecimal generators and tests. (tickets: 4 )
2017-03-08 Change: Add type conversion methods. (tickets: 3 )
2017-03-08 Change: Allow areas to be treated as area sizes. (tickets: 5 )
2017-03-09 Change: Add methods to return sizes from areas. (tickets: 2 )
2017-03-08 Release: com.io7m.jregions 0.0.2
2017-03-08 Change: Use primogenitor 0.0.6.
2017-03-08 Release: com.io7m.jregions 0.0.1
2017-03-08 Change: Initial release.

Sources

This project uses Git to manage source code.

Repository: https://www.github.com/io7m-com/jregions

$ git clone https://www.github.com/io7m-com/jregions

License

Copyright © 2024 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.

Bug Tracker

The project uses GitHub Issues to track issues.