Realm is a mobile database that runs directly inside phones, tablets or wearables.

This repository holds adapters for combining Realm Java with Android UI components and framework classes.

Currently supported UI components are:

• ListView
• RecyclerView

Getting Started

This library only works together with Realm Java. Please see the detailed instructions in our docs to add Realm to your project.

To add the adapters to your project, add the following to you app's dependencies:

repositories {
    jcenter()
}

dependencies {
    compile 'io.realm:android-adapters:3.1.0'
}

This library is only compatible with Realm Java 3.0.0 and above.

Documentation

Documentation for Realm can be found at realm.io/docs/java. The API reference is located at realm.io/docs/java/api.

Getting Help

• Need help with your code?: Look for previous questions on the #realm tag — or ask a new question. We activtely monitor & answer questions on SO!
• Have a bug to report? Open an issue. If possible, include the version of Realm, a full log, the Realm file, and a project that shows the issue.
• Have a feature request? Open an issue. Tell us what the feature should do, and why you want the feature.
• Sign up for our Community Newsletter to get regular tips, learn about other use-cases and get alerted of blogposts and tutorials about Realm.

Using Snapshots

If you want to test recent bugfixes or features that have not been packaged in an official release yet, you can use a -SNAPSHOT release of the current development version of Realm via Gradle, available on OJO

repositories {
    maven {
        url 'http://oss.jfrog.org/artifactory/oss-snapshot-local'
    }
}

dependencies {
    compile 'io.realm:android-adapters:<version>'
}

See version.txt for the latest version number.

Building Realm Android Adapters

In case you don't want to use the pre-compiled version, you can build the library from source.

Prerequisites:

• Download/the JDK 7 or JDK 8 from Oracle and install it.
• Download & install the Android SDK, Android 7.1 (API 25) (for example through Android Studio’s Android SDK Manager)

Once you have completed all the pre-requisites building Realm is done with a simple command

./gradlew assemble

That command will generate:

• an aar file for the adapter library in adapters/build/outputs/aar/android-adapters-release.aar

Other Commands

• ./gradlew monkeyDebug will run the monkey tests on the example project.
• ./gradlew javadoc will create the javadoc for the library.
• ./gradlew artifactoryPublish will upload a SNAPSHOT to OJO.
• ./gradlew bintrayUpload will upload a release to Bintray.

Contributing

See CONTRIBUTING.md for more details!

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

License

Realm Android Adapters is published under the Apache 2.0 license.

Feedback

If you use Realm and are happy with it, all we ask is that you please consider sending out a tweet mentioning @realm, or email [email protected] to let us know about it!

And if you don't like it, please let us know what you would like improved, so we can fix it!