Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 1.96 KB

README.md

File metadata and controls

63 lines (44 loc) · 1.96 KB
Raw

OpenDAL Java Bindings

Maven Central Website

Getting Started

This project is built upon the native OpenDAL lib. And it is released for multiple platforms that you can use a classifier to specify the platform you are building the application on.

Generally, you can first add the os-maven-plugin for automatically detect the classifier based on your platform:

<build>
    <extensions>
        <extension>
            <groupId>kr.motd.maven</groupId>
            <artifactId>os-maven-plugin</artifactId>
            <version>1.7.0</version>
        </extension>
    </extensions>
</build>

Then add the dependency to opendal-java as following:

<dependency>
  <groupId>org.apache.opendal</groupId>
  <artifactId>opendal-java</artifactId>
  <version>${opendal.version}</version>
  <classifier>${os.detected.classifier}</classifier>
</dependency>

Build

This project provides OpenDAL Java bindings with artifact name opendal-java. It depends on JDK 8 or later.

You can use Maven to build both Rust dynamic lib and JAR files with one command now:

mvn clean package -DskipTests=true

Run tests

Currently, all tests are written in Java. It contains the Cucumber feature tests and other unit tests.

You can run tests with the following command:

mvn clean verify

Additionally, this project uses spotless for code formatting so that all developers share a consistent code style without bikeshedding on it.

You can apply the code style with the following command::

mvn spotless:apply