https://github.com/Jintin/TypedBundle

Type safe Bundle for Android development
https://github.com/Jintin/TypedBundle

Last synced: 9 days ago
JSON representation

Type safe Bundle for Android development

• Host: GitHub
• URL: https://github.com/Jintin/TypedBundle
• Owner: Jintin
• License: apache-2.0
• Created: 2023-08-29T06:37:46.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-12-04T06:52:02.000Z (12 months ago)
• Last Synced: 2024-08-02T19:38:48.877Z (4 months ago)
• Language: Kotlin
• Size: 169 KB
• Stars: 27
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - Jintin/TypedBundle - Type safe Bundle for Android development (Kotlin)

README

        
# TypedBundle

[![CircleCI](https://dl.circleci.com/status-badge/img/gh/Jintin/TypedBundle/tree/master.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/Jintin/TypedBundle/tree/master) [![Maven Central](https://img.shields.io/maven-central/v/io.github.jintin/typed-bundle)](https://mvnrepository.com/artifact/io.github.jintin/typed-bundle)

A type safe `Bundle` for Android development.

`Bundle` is essential component in Android development from Day 1, but the flexible key-value structure don't limiting us from put a `String` and get an `Int` back with same key (and which will cause crash not compile error). This library is aimed to transform the plain String key into a type based class (such as `StringKey` or `IntKey` in below example) to align the type usage on both get and set side.

And the wrapper class (`StringKey` or `IntKey` for example) will be replace to actual String after compiled thanks to kotlin `value class` so no additional overhead.

## Install

```kotlin

dependencies {

    implementation("io.github.jintin:typed-bundle:0.5.0")

}

```

## Usage

```kotlin

val textKey = StringKey("SomeStringKey")

val intKey = IntKey("SomeIntKey")

val bundle = Bundle()

// Bundle usage

bundle[textKey] = "Some text"         // only String value is allowed

bundle[intKey] = 12345                // only Int value is allowed

val text = bundle.get(textKey, "")    // guarantee result to be a String

val text = bundle[textKey]            // guarantee result to be a String?

val int = bundle.get(intKey, -1)      // guarantee result to be an Int

val int = bundle[intKey]              // guarantee result to be an Int

// Intent usage

intent.putExtra(textKey, "Some text") // only String value is allowed

intent.putExtra(intKey, 12345)        // only Int value is allowed

val text = intent.getExtra(textKey)   // guarantee result to be a String?  

val int = intent.getExtra(intKey, -1) // guarantee result to be an Int

```

You can go to ./app module for more information.

## License

**TypedBundle** is released under Apache License 2.0.

See [LICENSE](https://github.com/Jintin/TypedBundle/blob/master/LICENSE) for more details.