Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/realm/realm-android-adapters
Adapters for combining Realm Java with Android UI components and framework classes
https://github.com/realm/realm-android-adapters
android java realm ui-components
Last synced: 23 days ago
JSON representation
Adapters for combining Realm Java with Android UI components and framework classes
- Host: GitHub
- URL: https://github.com/realm/realm-android-adapters
- Owner: realm
- License: apache-2.0
- Created: 2016-04-26T08:07:38.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-11-23T11:01:28.000Z (about 3 years ago)
- Last Synced: 2024-08-05T10:09:39.102Z (4 months ago)
- Topics: android, java, realm, ui-components
- Language: Java
- Homepage: realm.io
- Size: 379 KB
- Stars: 415
- Watchers: 17
- Forks: 135
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-realm - realm-android-adapters - Adapters for combining Realm Java with Android UI components and framework classes (<a name="java"> Java/Kotlin / <a name="java-libs"></a>Java/Kotlin Libraries and Components)
README
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](https://developer.android.com/reference/android/widget/ListView.html)
* [RecyclerView](https://developer.android.com/reference/android/support/v7/widget/RecyclerView.html)
## Getting Started
This library only works together with Realm Java. Please see the [detailed instructions in our docs](https://realm.io/docs/java/#installation)
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](https://realm.io/docs/java).
The API reference is located at [realm.io/docs/java/api](https://realm.io/docs/java/api).
## Getting Help
- **Need help with your code?**: Look for previous questions on the [#realm tag](https://stackoverflow.com/questions/tagged/realm?sort=newest) — or [ask a new question](http://stackoverflow.com/questions/ask?tags=realm). We activtely monitor & answer questions on SO!
- **Have a bug to report?** [Open an issue](https://github.com/realm/realm-android-adapters/issues/new). 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](https://github.com/realm/realm-android-adapters/issues/new). Tell us what the feature should do, and why you want the feature.
- Sign up for our [**Community Newsletter**](http://eepurl.com/VEKCn) 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](http://oss.jfrog.org/oss-snapshot-local/io/realm/realm-android/)
```gradle
repositories {
maven {
url 'http://oss.jfrog.org/artifactory/oss-snapshot-local'
}
}
dependencies {
compile 'io.realm:android-adapters:'
}
```
See [version.txt](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**](http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html) or [**JDK 8**](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) 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](CONTRIBUTING.md) for more details!
This project adheres to the [Contributor Covenant Code of Conduct](https://realm.io/conduct).
By participating, you are expected to uphold this code. Please report
unacceptable behavior to [[email protected]](mailto:[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](http://twitter.com/realm), or email [[email protected]](mailto:[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!_**
