objectbox/objectbox-java

Additional Kotlin extensions

Open

#446 opened on May 14, 2018

View on GitHub
 (9 comments) (0 reactions) (1 assignee)Java (348 forks)batch import
help wanted

Repository metrics

Stars
 (4,275 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

ObjectBox already provides some minimal Kotlin extensions:

// Regular
val box: Box<DataClassEntity> = store.boxFor(DataClassEntity::class.java)

// With extension
val box: Box<DataClassEntity> = store.boxFor()

// Regular
val query = box.query().`in`(property, array).build()

// With extension
val query = box.query().inValues(property, array).build()

This issue is to track what other Kotlin extensions may be added.

Some ground rules:

  • should leverage features unique to Kotlin
  • should not just be a shorter version of an existing method
  • should not optimize fur just a single use case

Things to look out for:

  • default args for methods
  • builder pattern
  • making util methods discoverable from the type they operate on
  • destructuring

-ut

Contributor guide

Research direction
Review the existing Kotlin extensions and documentation to identify patterns that can be improved using Kotlin specific features like default args, builder pattern, destructuring, etc. Then propose new extensions that leverage these features.
Tech stack
kotlinjava
Domain
database
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
KotlinObjectBox
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70