Kotlin: deprecate extension function for old query API

Author: greenrobot-team

objectbox-kotlin/src/main/kotlin/io/objectbox/kotlin/Box.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 ObjectBox Ltd. All rights reserved.
+ * Copyright 2021-2025 ObjectBox Ltd. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,13 +22,17 @@ import io.objectbox.query.QueryBuilder
 
 
 /**
+ * Note: new code should use the [Box.query] functions directly, including the new query API.
+ *
  * Allows building a query for this Box instance with a call to [build][QueryBuilder.build] to return a [Query] instance.
+ *
  * ```
  * val query = box.query {
  *     equal(Entity_.property, value)
  * }
  * ```
  */
+@Deprecated("New code should use query(queryCondition).build() instead.")
 inline fun <T> Box<T>.query(block: QueryBuilder<T>.() -> Unit): Query<T> {
     val builder = query()
     block(builder)

tests/objectbox-java-test/src/test/java/io/objectbox/query/QueryTestK.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2020-2025 ObjectBox Ltd. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package io.objectbox.query
 
 import io.objectbox.TestEntity_
@@ -19,7 +35,8 @@ class QueryTestK : AbstractQueryTest() {
         val resultJava = box.query().`in`(TestEntity_.simpleLong, valuesLong).build().use {
             it.findFirst()
         }
-        val result = box.query {
+        // Keep testing the old query API on purpose
+        @Suppress("DEPRECATION") val result = box.query {
             inValues(TestEntity_.simpleLong, valuesLong)
         }.use {
             it.findFirst()
@@ -33,8 +50,8 @@ class QueryTestK : AbstractQueryTest() {
         putTestEntity("Fry", 12)
         putTestEntity("Fry", 10)
 
-        // current query API
-        val query = box.query {
+        // Old query API
+        @Suppress("DEPRECATION") val query = box.query {
             less(TestEntity_.simpleInt, 12)
             or()
             inValues(TestEntity_.simpleLong, longArrayOf(1012))
@@ -46,7 +63,7 @@ class QueryTestK : AbstractQueryTest() {
         assertEquals(10, results[0].simpleInt)
         assertEquals(12, results[1].simpleInt)
 
-        // suggested query API
+        // New query API
         val newQuery = box.query(
                 (TestEntity_.simpleInt less 12 or (TestEntity_.simpleLong oneOf longArrayOf(1012)))
                         and (TestEntity_.simpleString equal "Fry")