Better deprecation messages

Author: jeffgbutler

src/main/kotlin/org/mybatis/dynamic/sql/util/kotlin/CriteriaCollector.kt

@@ -23,10 +23,10 @@ import org.mybatis.dynamic.sql.ExistsPredicate
 import org.mybatis.dynamic.sql.SqlCriterion
 import org.mybatis.dynamic.sql.VisitableCondition
 
-@Deprecated("Deprecated in favor of the new where clause DSL. Please see the documentation for new usage.")
+@Deprecated("Deprecated in favor of the new where clause DSL.")
 typealias CriteriaReceiver = CriteriaCollector.() -> Unit
 
-@Deprecated("Deprecated in favor of the new where clause DSL. Please see the documentation for new usage.")
+@Deprecated("Deprecated in favor of the new where clause DSL.")
 @MyBatisDslMarker
 class CriteriaCollector {
     val criteria = mutableListOf<AndOrCriteriaGroup>()

src/main/kotlin/org/mybatis/dynamic/sql/util/kotlin/KotlinBaseBuilders.kt

@@ -58,82 +58,91 @@ abstract class KotlinBaseBuilder<D : AbstractWhereSupport<*>, B : KotlinBaseBuil
             whereApplier.invoke(this)
         }
 
-    @Deprecated("Deprecated in favor of the new where clause DSL. Please see the documentation for new usage.")
+    @Deprecated("Deprecated in favor of the new where clause DSL. Update by moving the column and condition " +
+            "into a lambda and rewriting the condition to use an infix function.")
     fun <T> where(column: BindableColumn<T>, condition: VisitableCondition<T>): B =
         applyToWhere {
             where(column, condition)
         }
 
-    @Deprecated("Deprecated in favor of the new where clause DSL. Please see the documentation for new usage.")
+    @Deprecated("Deprecated in favor of the new where clause DSL. Update by moving the column and condition " +
+            "inside the lambda and rewriting the condition to use an infix function.")
     fun <T> where(column: BindableColumn<T>, condition: VisitableCondition<T>, subCriteria: CriteriaReceiver): B =
         applyToWhere(subCriteria) { sc ->
             where(column, condition, sc)
         }
 
     @Deprecated(
-        message = "Deprecated in favor of the new where clause DSL. Please see the documentation for new usage.",
+        message = "Deprecated in favor of the new where clause DSL.",
         replaceWith = ReplaceWith("where { existsPredicate }")
     )
     fun where(existsPredicate: ExistsPredicate): B =
         applyToWhere {
             where(existsPredicate)
         }
 
-    @Deprecated("Deprecated in favor of the new where clause DSL. Please see the documentation for new usage.")
+    @Deprecated("Deprecated in favor of the new where clause DSL. Update by moving the exists expression " +
+            "into the lambda.")
     fun where(existsPredicate: ExistsPredicate, subCriteria: CriteriaReceiver): B =
         applyToWhere(subCriteria) { sc ->
             where(existsPredicate, sc)
         }
 
-    @Deprecated("Deprecated in favor of the new where clause DSL. Please see the documentation for new usage.")
+    @Deprecated("Deprecated in favor of the new where clause DSL. Update by moving the column and condition " +
+            "into a lambda and rewriting the condition to use an infix function.")
     fun <T> and(column: BindableColumn<T>, condition: VisitableCondition<T>): B =
         applyToWhere {
             and(column, condition)
         }
 
-    @Deprecated("Deprecated in favor of the new where clause DSL. Please see the documentation for new usage.")
+    @Deprecated("Deprecated in favor of the new where clause DSL. Update by moving the column and condition " +
+            "inside the lambda and rewriting the condition to use an infix function.")
     fun <T> and(column: BindableColumn<T>, condition: VisitableCondition<T>, subCriteria: CriteriaReceiver): B =
         applyToWhere(subCriteria) { sc ->
             and(column, condition, sc)
         }
 
     @Deprecated(
-        message = "Deprecated in favor of the new where clause DSL. Please see the documentation for new usage.",
+        message = "Deprecated in favor of the new where clause DSL.",
         replaceWith = ReplaceWith("and { existsPredicate }")
     )
     fun and(existsPredicate: ExistsPredicate): B =
         applyToWhere {
             and(existsPredicate)
         }
 
-    @Deprecated("Deprecated in favor of the new where clause DSL. Please see the documentation for new usage.")
+    @Deprecated("Deprecated in favor of the new where clause DSL. Update by moving the exists expression " +
+            "into the lambda.")
     fun and(existsPredicate: ExistsPredicate, subCriteria: CriteriaReceiver): B =
         applyToWhere(subCriteria) { sc ->
             and(existsPredicate, sc)
         }
 
-    @Deprecated("Deprecated in favor of the new where clause DSL. Please see the documentation for new usage.")
+    @Deprecated("Deprecated in favor of the new where clause DSL. Update by moving the column and condition " +
+            "into a lambda and rewriting the condition to use an infix function.")
     fun <T> or(column: BindableColumn<T>, condition: VisitableCondition<T>): B =
         applyToWhere {
             or(column, condition)
         }
 
-    @Deprecated("Deprecated in favor of the new where clause DSL. Please see the documentation for new usage.")
+    @Deprecated("Deprecated in favor of the new where clause DSL. Update by moving the column and condition " +
+            "inside the lambda and rewriting the condition to use an infix function.")
     fun <T> or(column: BindableColumn<T>, condition: VisitableCondition<T>, subCriteria: CriteriaReceiver): B =
         applyToWhere(subCriteria) { sc ->
             or(column, condition, sc)
         }
 
     @Deprecated(
-        message = "Deprecated in favor of the new where clause DSL. Please see the documentation for new usage.",
+        message = "Deprecated in favor of the new where clause DSL.",
         replaceWith = ReplaceWith("or { existsPredicate }")
     )
     fun or(existsPredicate: ExistsPredicate): B =
         applyToWhere {
             or(existsPredicate)
         }
 
-    @Deprecated("Deprecated in favor of the new where clause DSL. Please see the documentation for new usage.")
+    @Deprecated("Deprecated in favor of the new where clause DSL. Update by moving the exists expression " +
+            "into the lambda.")
     fun or(existsPredicate: ExistsPredicate, subCriteria: CriteriaReceiver): B =
         applyToWhere(subCriteria) { sc ->
             or(existsPredicate, sc)

src/main/kotlin/org/mybatis/dynamic/sql/util/kotlin/elements/SqlElements.kt

@@ -151,11 +151,13 @@ fun <T> isNull(): IsNull<T> = SqlBuilder.isNull()
 
 fun <T> isNotNull(): IsNotNull<T> = SqlBuilder.isNotNull()
 
-@Deprecated("Deprecated in favor of the new where clause DSL. Please see the documentation for new usage.")
+@Deprecated("Deprecated in favor of the new where clause DSL. " +
+        "Rewrite to use the exists function inside a lambda.")
 fun exists(subQuery: KotlinSubQueryBuilder.() -> Unit): ExistsPredicate =
     SqlBuilder.exists(KotlinSubQueryBuilder().apply(subQuery))
 
-@Deprecated("Deprecated in favor of the new where clause DSL. Please see the documentation for new usage.")
+@Deprecated("Deprecated in favor of the new where clause DSL. " +
+        "Rewrite to use the exists function inside a \"not\" expression.")
 fun notExists(subQuery: KotlinSubQueryBuilder.() -> Unit): ExistsPredicate =
     SqlBuilder.notExists(KotlinSubQueryBuilder().apply(subQuery))