jeucreader
The jeucreader package provides an interface for reading Unicode codepoints
one at a time.
Features
- Unicode codepoint reader interface.
- High coverage test suite.
- Written in pure Java 17 with no dependencies.
- OSGi-ready
- JPMS-ready
- ISC license.
Motivation
For some reason, Java does not expose any interface to read individual Unicode
codepoints from any kind of I/O stream. It does provide methods to, for
example, read text into a String and then iterate over the codepoints of
the String.
The jeucreader package attempts to provide this missing functionality.
Usage
Given a java.io.Reader r, instantiate a UnicodeCharacterReaderType and
use it to read individual codepoints:
Reader r;
try (var u = UnicodeCharacterReader.newReader(r)) {
int c0 = u.readCodePoint();
int c1 = u.readCodePoint();
int c2 = u.readCodePoint();
...
}
On consuming malformed text, the reader may raise subtypes of IOException
such as InvalidSurrogatePair, MissingLowSurrogate, OrphanLowSurrogate,
and etc.
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 3.0.1.
3.0.1 Release (2024-05-10Z)
- 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.jeucreader</group> <artifactId>com.io7m.jeucreader.core</artifactId> <version>3.0.1</version> </dependency><dependency> <group>com.io7m.jeucreader</group> <artifactId>com.io7m.jeucreader.tests</artifactId> <version>3.0.1</version> </dependency>
Previous Releases
The changelogs for the most recent previous releases are as follows:
3.0.0 Release (2019-06-23Z)
- Require JDK 17 (Backwards incompatible)
2.0.0 Release (2017-11-04Z)
- Require JDK 9 and publish a Java 9 module. (Backwards incompatible)
- Remove com.io7m.jnull dependency. (Backwards incompatible)
1.1.2 Release (2017-04-06Z)
- Rename project. Use the new primogenitor POM and 2017 project conventions.
1.1.1 Release (2016-08-05Z)
- Correct OSGi exports.
Development Snapshots
At the time of writing, the current unstable development version of the package is 3.0.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/jeucreader
$ git clone --recursive https://www.github.com/io7m-com/jeucreader
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.