hexedtech/codemp
3
0
Fork 0
mirror of https://github.com/hexedtech/codemp.git synced 2024-12-23 21:34:54 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
codemp/dist/java
History
zaaarf 7d6b14fe7a
fix(java): bundle mac binaries too
2024-09-09 20:59:07 +02:00
..
src/mp/code fix(java): borked glue methods 2024-09-09 16:06:05 +02:00
build.gradle fix(java): bundle mac binaries too 2024-09-09 20:59:07 +02:00
README.md docs: improved cargo docs, rewrote readme 2024-09-05 01:45:48 +02:00
settings.gradle chore: cleanup, reorganizing java glue 2024-08-08 00:29:54 +02:00

README.md

Java bindings

codemp's Java bindings are implemented using the JNI.

On the Rust side, all Java-related code is gated behind the java feature, and is implemented usingjni-rs. Unlike other languages, Java requires glue code on both sides: as a result, a Java component is necessary.

Building

This is a Gradle project: building requires having both Gradle and Cargo installed, as well as the JDK (any non-abandoned version). Once you have all the requirements, building is as simple as running gradle build: the output is going to be a JAR under build/libs, which you can import into your classpath with your IDE of choice.

Development

The Java bindings have no known major quirk. However, here are a list of facts that are useful to know when developing with these:

  • Memory management is entirely delegated to the JVM's garbage collector.
    • A more elegant solution than Object.finalize(), who is deprecated in newer Java versions, may be coming eventually.
  • Exceptions coming from the native side have generally been made checked to imitate Rust's philosophy with Result.
    • JNIExceptions are however unchecked: there is nothing you can do to recover from them, as they usually represent a severe error in the glue code. If they arise, it's probably a bug.